144
SmartPlant Materials Adapter and Integration Configuration Guide Version 2011 (7.0.0) June 2010 DMAR1-PE-200058D

SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Embed Size (px)

Citation preview

Page 1: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

SmartPlant Materials Adapter and Integration Configuration Guide

Version 2011 (7.0.0) June 2010 DMAR1-PE-200058D

Page 2: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Copyright Copyright © 2005-2010 Intergraph Corporation. All Rights Reserved. Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.

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 52.227-19 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 252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3. Unpublished - rights reserved under the copyright laws of the United States. Intergraph Corporation P.O. Box 240000 Huntsville, AL 35813 Street address: 170 Graphics Drive, Madison, AL 35758

Terms of Use Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives licensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement and delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for resale or redistribution.

Warranties and Liabilities All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software or applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such warranties. 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 discussed in this document is furnished under a license and may be used or copied only in accordance with the terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT. 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.

Trademarks Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools, ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are trademarks of their respective owners.

Page 3: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

SmartPlant Materials Adapter and Integration Configuration Guide 3

Contents Preface .......................................................................................................................................................... 5 

What's New? ................................................................................................................................................ 5 

Introduction ................................................................................................................................................. 7 

Adapter Architecture ............................................................................................................................... 9 SmartPlant Materials Publish-Retrieve Relationships .................................................................... 10 UID Construction ........................................................................................................................... 10 Plant Breakdown Structure ............................................................................................................. 10 

SmartPlant Materials Installation .......................................................................................................... 11 SmartPlant Materials Configuration ..................................................................................................... 11 

SmartPlant Materials Projects ........................................................................................................ 11 Database Settings ........................................................................................................................... 12 Project Defaults .............................................................................................................................. 12 Publishing Settings ......................................................................................................................... 13 Document Retrieving Settings........................................................................................................ 14 SmartPlant Foundation Web Client ................................................................................................ 14 Requisitions and Purchase Orders .................................................................................................. 15 BOM Retrieving Settings ............................................................................................................... 16 Plant Breakdown Structure (PBS) Retrieval Settings .................................................................... 22 File-Based BOM Retrieve Settings ................................................................................................ 23 

Mapping ..................................................................................................................................................... 25 

Mapping for BOM Retrieve from SmartPlant 3D ................................................................................ 28 SmartPlant Materials BOM Nodes ................................................................................................. 29 SmartPlant Materials BOM Positions ............................................................................................ 40 SmartPlant Materials Tagged Items ............................................................................................... 45 Additional Attributes ...................................................................................................................... 47 

Mapping for BOM Retrieve from SmartPlant Isometrics ..................................................................... 53 SmartPlant Materials BOM Nodes ................................................................................................. 54 SmartPlant Materials BOM Positions ............................................................................................ 56 Additional Attributes ...................................................................................................................... 59 

MTI-DB ...................................................................................................................................................... 61 

MTI-DB Installation ............................................................................................................................. 61 MTI-DB Migration from 6.3.8 to 7.0.0 ................................................................................................ 71 

MTI-UI ....................................................................................................................................................... 75 

MTI-UI Installation ............................................................................................................................... 75 MTI-UI Configuration .......................................................................................................................... 77 

Common Configuration Tasks ....................................................................................................... 77 Configure Document Retrieval ...................................................................................................... 93 

Page 4: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Contents

4 SmartPlant Materials Adapter and Integration Configuration Guide

Configure SmartPlant Materials Publish ...................................................................................... 101 Control Processing ....................................................................................................................... 107 

MTI-S ....................................................................................................................................................... 115 

General Requirements ......................................................................................................................... 115 MTI-S Installation............................................................................................................................... 116 

First Installation ............................................................................................................................ 116 Upgrading from Previous Versions .............................................................................................. 122 

MTI-S Configuration .......................................................................................................................... 123 Starting MTI-S .................................................................................................................................... 124 

Configure Line List Integration ............................................................................................................. 127 

Limitations .......................................................................................................................................... 128 Line List Mapping .............................................................................................................................. 129 

Line List Documents Publish Mapping ........................................................................................ 129 Map Additional Properties ........................................................................................................... 131 Unit of Measure Mapping ............................................................................................................ 133 Enumerated Lists Mapping .......................................................................................................... 136 

Configure MTI to Publish Line List Documents ................................................................................ 140 MTI 10.32 SmartPlant Materials Publish Type Mappings ........................................................... 140 

Index ......................................................................................................................................................... 143 

Page 5: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

SmartPlant Materials Adapter and Integration Configuration Guide 5

This document describes the necessary installation and configuration steps for integrating SmartPlant Materials with SmartPlant. The involved components are SmartPlant Materials databases, SmartPlant Materials application servers, the SmartPlant Materials map schema, the Materials Tool for Integration Scheduler (MTI-S) with the underlying MTI database, and the MTI-UI to set up the configuration.

Document Audience This document is intended for administrators who should: Have an in-depth understanding of the SmartPlant Materials software. Be familiar with SmartPlant Foundation architecture and functionality.

Related Documents For more information about SmartPlant Materials and integration, please also see the following documents: SmartPlant Materials Tool for Integration User's Guide

Documentation Comments Send documentation comments or suggestions to [email protected].

This document has been updated to reflect the version changes: SmartPlant Materials from 6.3 to 7.0.0 and Oracle DB/AS from 10g to 11g. (June 2010)

Topics that describe configuration to retrieve line lists from SmartPlant Foundation and transfer these lists to SmartPlant Materials have been added to this document. (March 2009)

Topics that describe retrieving SmartPlant Isometrics POD documents for the Bill of Materials (BOM) have been added to this document. (June 2008)

Preface

What's New?

Page 6: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

What's New?

6 SmartPlant Materials Adapter and Integration Configuration Guide

Page 7: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

SmartPlant Materials Adapter and Integration Configuration Guide 7

In a typical SmartPlant Materials integration scenario, many SmartPlant Materials databases can be integrated within one SmartPlant environment. MTI-DB and MTI-S are required, and only one instance is allowed. Do not try to run more than one instance of MTI-S with one MTI-DB and one SmartPlant environment. The following graphic provides an overview of the components involved.

SmartPlant Materials web client The web client is the actual user interface for SmartPlant Materials users. For SmartPlant integration, screen A.20.01.02 Project Information has been enhanced to show if a SmartPlant Materials project is "SmartPlant integrated". Setting some new project defaults is necessary to configure publishing. There is no direct access to the MTI-DB or MTI-UI from within SmartPlant Materials. Documents coming from SmartPlant Foundation are integrated into standard SmartPlant Materials workflows, showing very little differences. The document screens and document pick lists show an additional indicator field to separate SmartPlant Foundation documents from generic

Introduction

Page 8: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

8 SmartPlant Materials Adapter and Integration Configuration Guide

SmartPlant Materials documents, and several other fields are filled with data retrieved from SmartPlant.

SmartPlant Materials Databases (SPMat DB) SmartPlant Materials databases - as a component in this document - are the entire data stores (Oracle databases) of every single standard SmartPlant Materials installation involved in the integration with one SmartPlant environment. The number of SmartPlant Materials databases to be integrated in this scenario is not restricted. The physical links to each database are established from MTI-DB to a particular SmartPlant Materials database, not vice versa. There are very few changes to the SmartPlant Materials database schema for SmartPlant integration.

SmartPlant Materials Application Server The SmartPlant Materials application server is based on Oracle Fusion Middleware. Standard screens and libraries - developed with Oracle forms - are stored in a single directory, which the application server (AS) configuration points to. The application server answers all user requests coming from web clients. MTI application screens reside in the same directory on the AS as the standard SmartPlant Materials screens. The configuration file (formsweb.cfg) must have another entry for calling the logon screen added in MTI-UI. The web client starts the application by calling a URL using this configuration entry.

MTI-User Interface The MTI-UI is the actual user interface where administrators do the necessary steps to configure the environment stored in the MTI Database. The necessary screens are developed with Oracle Forms. MTI-UI is web-enabled by means of Oracle iAS, just like the SmartPlant Materials web client.

MTI Database (MTI-DB) This database is an Oracle database of the same version as the integrated SmartPlant Materials databases. Physically, it can reside on Windows or UNIX platforms, as it will be accessed via SQLNet. Of course, the necessary objects of the MTI-DB can be installed in an already existing database, but this is not recommended. The MTI-DB hosts the MTI entities and necessary application logic in an additional database schema called MTI_SYS. MTI-DB is also the point where necessary database links to all SmartPlant Materials databases are to be established. A compatibility check for the correct SmartPlant Materials versions in the integrated databases will take place by the time a database link is established or used.

SmartPlant Materials Tool for Integration with SmartPlant (MTI-S) MTI-S is a Visual Basic application acting as a scheduled processor for integration tasks. It reads its initial information from an ini file, specifically the connection parameters to the MTI-DB. MTI-S must reside on a machine where the SmartPlant Client and Schema Components are installed. Its main purpose is to act as a substitute for the user interface that other applications add to their tools to achieve integration with SmartPlant. Instead of user interaction, the process starts tasks by reading appropriate commands from a workload table residing in the MTI-DB and invoking IEF

Page 9: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

SmartPlant Materials Adapter and Integration Configuration Guide 9

Adapter methods by means of IEFCommonUIApplication2 that the SmartPlant client exposes instead. To prevent MTI-S from running all the time, a simple delay value is read from the ini file. The software will not start up without proper information from its ini file.

See Also SmartPlant Materials Configuration (on page 11) SmartPlant Materials Installation (on page 11)

Adapter Architecture The general architecture of the SmartPlant Materials Tool for Integration is as shown below.

SmartPlant Materials Tool for Integration UI (MTI-UI) The SmartPlant Materials Tool for Integration User Interface (MTI-UI) is an independent Oracle Forms application for administrative use with the MTI database. It allows the user to integrate all accessible SmartPlant Materials databases within one single integrated environment.

SmartPlant Materials Tool for Integration Services (MTI-S) The MTI-S is a Visual Basic application acting as a scheduled processor for integration tasks. It reads its initial information from an ini-file, specifically the connection parameters to the MTI-DB. It must reside on a machine where the SmartPlant Client and Schema Components are installed. Its main purpose is to act as a substitute for the user interface that other applications add to their tools to achieve integration with SmartPlant. Instead of user interaction, the process starts tasks by reading appropriate commands from a workload table residing in the MTI-DB and invoking IEF Adapter methods by means of IEFCommonUIApplication2 that the SmartPlant client exposes instead. To prevent the MTI-S from running all the time, a simple delay value is read from the .ini file. It won’t start up without proper information from its .ini file. The following interfaces are supported.

Publish Adapter IEFAdapter

Retrieve Adapter IEFAdapter

Page 10: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

10 SmartPlant Materials Adapter and Integration Configuration Guide

SmartPlant Materials Publish-Retrieve Relationships Publish Document Types The following shows the document types available for publish. Requisition for Inquiry Requisition for Purchase Purchase Order Line List Calculation

To configure the SmartPlant Materials publish types, see MTI 10.31 SmartPlant Materials Publish Types (on page 101).

Retrieve Document Types Pipeline Object Data (POD) Document Plant Breakdown Structure (PBS) SmartPlant Review Document 3D Bills of Materials

To configure the SmartPlant Materials document types for retrieve, see MTI 10.21 SPF Document Type Hierarchy (on page 93).

UID Construction The UIDs are generated in the MTI DB package mti_pck_util.get_mar_guid. This function is generating a UID by concatenation of a prefix “MAR_” with a value coming from Oracle's built-in function SYS_GUID.

Plant Breakdown Structure In an integrated environment, engineering data is organized using a plant breakdown structure (PBS). A plant breakdown structure is a hierarchy by which your plant is organized. For example, a PBS for organizing plant data might be plant/area/system/subsystem or plant/area/unit. The PBS hierarchy defined in the SmartPlant schema is used to create the PBS hierarchy in SmartPlant Foundation. This hierarchy is communicated to integrated authoring tools when SmartPlant Foundation publishes the plant breakdown structure and the tools retrieve it. In versions prior to 2007, the plant breakdown structure for integrated authoring tools was restricted to plant/area/unit. By default, the PBS for integration is still plant/area/unit in the schema. However, you can use the Schema Editor to configure the default hierarchy in the schema to meet your needs. For more information on retrieving the PBS for use with SmartPlant Materials, see MTI 10.22 Document Type Mappings (on page 97).

Page 11: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

SmartPlant Materials Adapter and Integration Configuration Guide 11

SmartPlant Materials Installation The SmartPlant Materials databases to be integrated with SmartPlant must have SmartPlant Materials 2011 installed. Except for the above mentioned version installation, there are no further installation steps for SmartPlant Materials regarding the integration with SmartPlant.

See Also Introduction (on page 7)

SmartPlant Materials Configuration The necessary configuration steps for integration purposes described below include specifying language settings in projects, several database settings, and project defaults in SmartPlant Materials. For more information about mapping properties and configuring SmartPlant Materials to integrate BOM and line lists, see the SmartPlant Materials MTI Install Guide.

SmartPlant Materials Projects Check the status of a SmartPlant Materials project on A.20.01.02 Project Information and set the language.

SmartPlant Enabled Indicator showing whether a project is enabled to publish data (currently, requisitions and purchase orders) to an integrated environment. This check box is unchecked by default. Changing this setting is only possible by means of MTI-UI, which controls the integration. No requisitions or purchase orders are published until this parameter has been set.

Default NLS The language chosen determines which short description and description values should be used for publishing purposes.

Page 12: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

12 SmartPlant Materials Adapter and Integration Configuration Guide

Database Settings To set the necessary values for integration-related database settings, use A.60.04 DBA Settings.

Project Defaults If the specific document in SmartPlant Materials has been retrieved, the SmartPlant Foundation Web Client opens and displays the view file of the document. With the setting of parameters ZI_SP_AUTH, ZI_SP_LDLG, ZI_SP_PW, and ZI_SP_USER, administrators can influence the way the logon to SmartPlant Foundation Web Client behaves. Viewing the files also requires the installation of SmartPlant Markup on the client machine.

Page 13: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

SmartPlant Materials Adapter and Integration Configuration Guide 13

To set the necessary values for integration-related project defaults, use A.20.12 Project Defaults.

See Also Document Retrieving Settings (on page 14) Publishing Settings (on page 13) Requisitions and Purchase Orders (on page 15) SmartPlant Foundation Web Client (on page 14)

Publishing Settings REPORT_SERVER The name of the report server is required if you want to use the Oracle report server architecture for running reports. This value is to be set properly for creation of publishable view files for requisitions and purchase orders.

SPF_REPORT_DEST Local path on the application server, where the created reports will be stored and later be picked up by SmartPlant services. This path must exist physically on the application server.

SPF_REPORT_DEST_DB Reserved for later use regarding file publish by http protocol. Must not be set at the moment.

SPF_REPORT_DEST_URL Reserved for later use regarding file publish by http protocol. Must not be set at the moment.

Page 14: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

14 SmartPlant Materials Adapter and Integration Configuration Guide

SPF_REPORT_PATH_UNC UNC path to the application server share (must be the same location physically as specified by SPF_REPORT_DEST ), where the view files to be published are located and can be picked up by SmartPlant services. This share must be accessible by the account on the machine where MTI-S and SmartPlant Client are installed. Example: \\myappserver.mydomain\my_file_share\ Do not forget the starting double backslash (\\) and the ending single backslash (\).

See Also SmartPlant Materials Configuration (on page 11)

Document Retrieving Settings SMARTPLANT_WEBCLIENT_FILTER This value is used to compose a specific part of the URL to SmartPlant Foundation Web Client. It is a necessary mechanism to guarantee that the document is uniquely identified while looking for it with the web client. Specify the following value: DynamicRevisionFilterUID At the moment, no other values are allowed.

SMARTPLANT_WEBCLIENT_URL You must specify a valid value of the following format: http://SPF_Server_Name.Domain/virtual_Directory.asp Example: http://dor-mds-as.ingr.com/SPF37.asp Ask your SmartPlant administrator for the exact notation.

See Also SmartPlant Materials Configuration (on page 11)

SmartPlant Foundation Web Client The following parameters are used to compose the URL to SmartPlant Foundation Web Client.

ZI_SP_AUTH A value of N sets a substring of the URL to 'authentication=false'; a value of Y sets 'authentication=true'. The correct value to be set depends on the integrated environment. Use Y if SmartPlant uses Windows authentication to logon; use N if it doesn't or if you are not sure about it.

ZI_SP_LDLG This parameter values are Y or N, meaning whether or not to display a logon dialog box. A value of Y overwrites the setting of ZI_SP_AUTH and sets 'authentication=false' and password to nothing automatically. A value of N will compose the URL by utilizing the other parameters and trying to logon automatically. If the logon is not successful because of user or password, SmartPlant will display a logon dialog anyway.

Page 15: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

SmartPlant Materials Adapter and Integration Configuration Guide 15

ZI_SP_PW A password string to be used with the username specified in parameter ZI_SP_USER. Beware that this can be a security problem as this parameter will be visible for all SmartPlant Materials project users.

ZI_SP_USER A default user to log on to the integrated environment. The value can be overwritten on the SmartPlant logon dialog box.

See Also SmartPlant Materials Configuration (on page 11)

Requisitions and Purchase Orders This section describes the impact of integration on SmartPlant Materials requisitions and purchase orders. Then, this section describes the parameters that determine the publishing process and the creation of view files for publishing purposes.

Requisitions Integration affects the 'Release to Procurement' action of screens R.30.01 and R.30.02 in the following way: The release to procurement will cause the requisition to be published under the following conditions: First, the project must be enabled for integration. See A.20.01.02 Project Information. Second, the requisition supplement is the first supplement, or the publishing has started with

the first supplement. The release to procurement action will fail if the view file could not be created and the project default ZI_SP_RFIL is set to Y, which means a view file is required for publish. Setting ZI_SP_RFIL to N will nevertheless start the view file creation but will not terminate the release to procurement because of error conditions during view file creation.

Purchase Orders Integration affects the Approve action of screen P.50.07 in the following way: The approval will cause the purchase order to be published under the following conditions: First, the project has to be enabled for integration. See A.20.01.02 Project Information. Second, the purchase order supplement is the first supplement, or the publishing has started

with the first supplement. The approve action will fail if the view file could not be created and the project default ZI_SP_PFIL is set to Y, which means a view file is required for publish. Setting ZI_SP_PFIL to N will nevertheless start the view file creation but will not terminate the approval because of error conditions during view file creation.

ZI_SP_PFIL Determines if a successful approve depends on the creation of the view file. If set to Y, the approval will terminate if any errors while creating the view files occur. If set to N, the approval succeeds also without the view file.

Page 16: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

16 SmartPlant Materials Adapter and Integration Configuration Guide

ZI_SP_PREP Name of the report template to be attached to the published purchase order. The report is freely definable by the customer and takes p_poh_id, which is the poh_id (primary key value) of the purchase order, as parameter. The delivered report SPF_PO is just a template that must be customized by the customer.

ZI_SP_RFIL Determines if a successful release to procurement depends on the creation of the view file. If set to Y, the release to procurement will terminate if any errors while creating the view files occur. If set to N, the release to procurement succeeds also without the view file.

ZI_SP_RREP Name of the report template to be attached to the published requisition. The report is freely definable by the customer and takes p_r_id, which is the r_id (primary key value) of the requisition, as parameter. The delivered report SPF_REQ is just a template that must be customized by the customer.

Additional Information to Publish with Requisitions or Purchase Orders When a requisition gets released to procurement or a purchase order gets approved, the necessary information to publish is collected in the background. To allow users to add additional information to a published item, there is a custom package called 'M_PCK_MTI_CUSTOM' in the SmartPlant Materials database. By using this package, five user-definable fields can be attached to any published requisition or purchase order.

See Also SmartPlant Materials Configuration (on page 11)

BOM Retrieving Settings The following parameters specify the import of data from retrieved BOM documents.

Project Defaults

ZI_SPE_ATD The pre-processor for BOM documents retrieved from SmartPlant Enterprise checks if attributes with new data are already available in SmartPlant Materials. Missing attributes will be created automatically. This project default specifies whether the attributes are to be created in a project or product group context. Possible values are PROJ, PG, EXISTING or NONE. If NONE is selected, the attributes check will not be processed at all. If the project default is not set, the processing will be done with a product group scope.

ZI_SPE_ITY Default item type for imported tagged items. Valid values are TWM or TOM. If this project default is not set, the processing will use TOM as the default value.

Page 17: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

SmartPlant Materials Adapter and Integration Configuration Guide 17

ZI_SP3D_CO Default company used to store SmartPlant 3D catalog data. The pre-processor for retrieved SmartPlant 3D BOM data uses this company to identify the material.

SmartPlant Materials Attributes To minimize the workload when using BOM import from SmartPlant Enterprise, a pre-processor will create node types, node attributes, and position attributes automatically after the BOM import has been started.

Mapping determines what becomes a node type or attribute.

A.50.01 Attributes To do this operation, the new attributes will be stored in attribute group SPE. This attribute group will also be created if not already available. The result can be viewed by using A.50.01 Attributes as shown below.

Because the attribute name in SmartPlant Materials is restricted to 30 characters, the original attribute name will be cut and concatenated with a trailing ID. The original value will additionally be stored in the SPE Attr Name column. This functionality also allows changing the attribute name according to the user's needs after attribute creation. The next time the processing of retrieved attributes occurs, the software will identify the matching SmartPlant Materials attribute by the SPE Attr Name.

Page 18: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

18 SmartPlant Materials Adapter and Integration Configuration Guide

The following table describes how the SPE Attributes will be selected / created in project / product group based on the project default ZI_SPE_ATD value.

The SPE Attrname can be mapped to a SmartPlant Materials attribute only once within a project and in product group. If user tries to map the same SPE Attrname to multiple SmartPlant Materials attribute within a project, a message appears stating that the software cannot associate the SPE attribute <SPE Attr Name> with the SPMAT attribute <SPMat Attr Name>. If a user tries to update the field SPE Attrname corresponding to the SPMat attribute in A.50.01 Attributes screen and if the attribute is already in use in BOM nodes or positions, a message appears stating that the attribute is already used in BOM and asking the user if they want to continue modifying the field. Click Yes in the message box to modify the SPE_Attrname.

B.10.03 Node Types Mapping determines which class definitions will become SmartPlant Materials BOM node types. Because the name of a node type is restricted to 10 characters in SmartPlant Materials, the matching names coming from SmartPlant 3D retrieved data are listed in the following tables.

ClassDefinition SmartPlant Materials Node Type

P3DPipelineSystem PIPELINE

P3DPipeRun PIPERUN

P3DPipingSystem PIPING

FunctionalArea AREA

FunctionalUnit UNIT

P3DDuctingSystem DUCTING

P3DMachinerySystem MACHINERY

P3DConduitSystem CONDUIT

P3DGenericSystem GENERIC

P3DElectricalSystem ELECTRICAL

P3DStructuralSystem STRUCTURAL

Page 19: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

SmartPlant Materials Adapter and Integration Configuration Guide 19

Additionally, when retrieving BOM data from POD Documents, the class definition PODPipeline is used to create SmartPlant Materials node type PIPELINE. The IsometricSheetNumber – published as a property – will be used to create a SmartPlant Materials node type ISO_SHEET. All other possible node types will be cut and concatenated with a trailing ID. The original value will additionally be stored in the SPE Node Type column. You can update the generated name of the node type.

Attributes mapped to MARIAN_BOM_NODE_ATTRIBUTES in the map file will be attached in the Assigned Attributes block as the example above shows.

B.10.04 Position Attributes Again, it is the mapping that determines the list of attributes. Here, the mapping of MARIAN_BOM_POS_ATTRIBUTES determines the retrieval of attributes for positions.

Page 20: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

20 SmartPlant Materials Adapter and Integration Configuration Guide

The login discipline of the user starting the BOM import determines the SmartPlant Materials discipline to which the attributes are attached.

Attribute Security In the SmartPlant Materials environments that use attribute security, it may be necessary to allow users to view the attributes attached to positions with SmartPlant Materials BOM screens.

Page 21: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

SmartPlant Materials Adapter and Integration Configuration Guide 21

After the new attributes have been created, open the A.20.06.11 Attribute Security screen, and add the attributes to the list of viewable attributes for the affected discipline.

Page 22: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

22 SmartPlant Materials Adapter and Integration Configuration Guide

The result looks like the following:

Plant Breakdown Structure (PBS) Retrieval Settings The following settings specify the retrieval of the plant breakdown structure (PBS).

Project Defaults

ZI_PBS_FU This project default, located on the Integrator tab, allows you to control whether functional / line units are automatically created or correlated when retrieving PBS Items.

Page 23: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

SmartPlant Materials Adapter and Integration Configuration Guide 23

If this project default is set Y, then functional / line units are created or correlated on screen L.10.03 PLL Units during retrieval of the PBS document.

If this project default is set N, the functional / line units will not be created or correlated. To create or correlate functional / line units manually, click Create / Correlate Line Units on B 40.51 SmartPlant Enterprise Docs screen.

File-Based BOM Retrieve Settings The following parameters specify the import of data retrieved from file-based BOM documents.

Project Defaults

ZI_BOM_DIR This project default holds the directory on the SmartPlant Materials application server where the retrieved BOM files from SmartPlant Foundation should be copied. The path to the directory must not have any spaces and and include a forward slash (/) at the end.

DBA Settings

SERVLET_PATH Path in the file system of the application server for servlets, including the name of the application server. You must specify your application server and the directory of the servlets, as <your_servername/j2ee/servlet>. Do include http:// in the path or / at the end of thepath. Including /servlet in the path is applicable if you installed the application as described in the web-installation guide. You must maintain this value if you want to work with modules where a file upload is performed such as B.40.01 OMI Import, G.10.01 Company Symbols or S.80.11 OII - Import Jobs.

Before you begin importing .b files into SmartPlant Materials, review the directory specified in the project default ZI_BOM_DIR. this directory must contains the files piping_g.ctl

Page 24: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Introduction

24 SmartPlant Materials Adapter and Integration Configuration Guide

and B40R01.sql. If these files do not exist, copy each file the download folder, for example, C:\Program Files\SmartPlant\Materials\download into the directory specified in the project default ZI_BOM_DIR.

Page 25: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

SmartPlant Materials Adapter and Integration Configuration Guide 25

To store SmartPlant Materials BOM data, all that is needed are items representing BOM nodes to build a hierarchical tree structure and BOM position items representing the material. BOM nodes and positions can optionally have additional attributes attached. To satisfy these requirements, a mapping must be defined accordingly. The procedure to customize the delivered mapping properly is described below. 1. Start Intergraph SmartPlant Foundation > Schema Component > Schema Editor -

Adapter Author. 2. Begin with Basic Workflows.

3. Under Schema, click Open.

Mapping

Page 26: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

26 SmartPlant Materials Adapter and Integration Configuration Guide

4. Select and open EFSchema.xml from the path where the schema files reside. This location will usually be C:\Program Files\Common Files\Intergraph\EFSchema in a standard installation.

5. After the EFSchema is loaded, click Open under Tool schema.

Page 27: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 27

6. Select and open MARIANMapSchema.xml from the path where the SmartPlant Materials map schema files reside. This location will be MarianAdapter\MapSchema\ according to the path chosen during installation of MTI-S.

7. After the map schema is loaded, choose Edit Map Classes and Properties from Actions

under Tool schema.

See Also Mapping for BOM Retrieve from SmartPlant 3D (on page 28) Mapping for BOM Retrieve from SmartPlant Isometrics (on page 53)

Page 28: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

28 SmartPlant Materials Adapter and Integration Configuration Guide

Mapping for BOM Retrieve from SmartPlant 3D The mapping delivered with the MTI-S installation allows you to retrieve data from the default SmartPlant 3D class definitions as BOM nodes, BOM positions, and BOM positions as tagged items (equipment). Additional attributes for nodes and positions are not mapped at all.

An overview of default mappings can be found in the MapPropSPMat2008--6-3-1.xls file that resides in the MarianAdapter\MapSchema\ folder according to the path chosen during installation of MTI-S. The following sections will describe the default mapping and explain how to customize the mapping.

It is recommended to make a backup copy before changing the SmartPlant Materials map schema. Changes should also be well-documented.

See Also SmartPlant Materials BOM Nodes (on page 28) SmartPlant Materials BOM Positions (on page 40) SmartPlant Materials Tagged Items (on page 45) Additional Attributes (on page 47)

Page 29: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 29

SmartPlant Materials BOM Nodes In SmartPlant 3D, the material is usually placed below system items such as P3DConduitSystem P3DDuctingSystem P3DElectricalSystem P3DGenericSystem P3DMachinerySystem (Equipment) P3DPipelineSystem P3DPipingSystem P3DPipeRun P3DStructuralSystem

Because the integration solution so far only covers piping material and equipment, and this material is usually placed below the P3DPipelineSystem, P3DPipingSystem, P3DPipeRun, or P3DMachinerySystem, the delivered map file has only those classdefs mapped. If the retrieved file contains piping material or equipment placed below another system item, the material will be processed nevertheless. But, the system item will not be processed. In this case, the material will be placed below the root node. To avoid this situation, affected system items have to be mapped before retrieving. The procedure to do this operation will be described later.

PBS items will be added to the SmartPlant Materials BOM node hierarchy automatically if a relationship exists from the retrieved SmartPlant 3D system item to the parent PBS item. SmartPlant Materials BOM nodes are represented by the MARIAN_BOM_NODE SPMapClassDef.

Page 30: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

30 SmartPlant Materials Adapter and Integration Configuration Guide

1. To edit this SPMapClassDef, select Edit MARIAN_BOM_NODE on the shortcut menu available by right-clicking the item.

2. On the next screen, click Map Properties in the Retrieve Map section.

Page 31: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 31

As a result, the Retrieve Map screen opens, and the mapping from MARIAN_BOM_NODE to each classdef can be viewed.

Each object's UID and name are always stored and used during processing. It is fixed that the Name property will be used as the BOM Node name in SmartPlant Materials. There is no need to map to those properties. Mappings of BOM_Node_Description and BOM_Node_ShortDesc to a SmartPlant 3D property are optional. If they are mapped and the value of the property is published, this information will go into the NLS Short Description and Description BOM nodes in SmartPlant Materials. The default mapping is the same for P3DMachinerySystem, P3DPipelineSystem, and P3DPipingSystem.

Page 32: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

32 SmartPlant Materials Adapter and Integration Configuration Guide

For mapping to the P3DPipeRun, the BOM_Node_NominalDiameter and BOM_SpecCode map properties are additional needed information for processing and should not be removed.

See Also Change Mapping of BOM_Node_ShortDesc or BOM_Node_Description (on page 32) Add a Class Definition Mapping to MARIAN_BOM_NODE (on page 37) Remove a Class Definition from Mapping (on page 40)

Change Mapping of BOM_Node_ShortDesc or BOM_Node_Description The optional map properties BOM_Node_ShortDesc or BOM_Node_Description can be mapped to another published property of the class definition. The example below uses the P3DPipelineSystem class definition and the BOM_Node_ShortDesc map property, which is mapped to the Name property by default.

Page 33: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 33

1. First, choose the class definition and browse to the mapped property. Right-click the mapped property in the MapProperty Def column. Select Delete Relationship between Name and BOM_Node_ShortDesc on the shortcut menu.

Page 34: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

34 SmartPlant Materials Adapter and Integration Configuration Guide

2. On the next screen, select the correct relationship again. Then, confirm the deletion by clicking Delete.

Page 35: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 35

As a result, the mapping has been deleted.

3. Create the new mapping by using drag and drop from the BOM_Node_ShortDesc map

property to the Map Property Def column of the property name.

Page 36: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

36 SmartPlant Materials Adapter and Integration Configuration Guide

It is possible to map BOM_Node_ShortDesc and BOM_Node_Description to the same property as shown in the example.

4. If you are done with the changes, close this window and return to the main editor screen.

Page 37: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 37

5. Save your work by clicking Save > Tool Schema File on the File menu.

See Also SmartPlant Materials BOM Nodes (on page 28)

Add a Class Definition Mapping to MARIAN_BOM_NODE As already explained, piping material and equipment placed below system items other than P3DPipelineSystem, P3DPipingSystem, P3DPipeRun, or P3DMachinerySystem will also be retrieved, but the system items will not. If the material of interest is placed below another system item type, the mapping must be edited to reflect the node hierarchy properly.

Page 38: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

38 SmartPlant Materials Adapter and Integration Configuration Guide

1. Click Edit MARIAN_BOM_NODE on the shortcut menu to open the following screen.

2. Click the Browse button with the three dots in the Retrieve Map section.

Page 39: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 39

3. Select the class definition, for example, P3DGenericSystem, and click OK.

P3DGenericSystem has been added to the Retrieve from EF class/interface list. After saving the changes, this class definition will be processed from now on. If the short description and description should be mapped, it is necessary to open the Retrieve Map screen by clicking Map Properties, and continuing in the way already described above.

See Also SmartPlant Materials BOM Nodes (on page 28)

Page 40: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

40 SmartPlant Materials Adapter and Integration Configuration Guide

Remove a Class Definition from Mapping 1. Click Edit MARIAN_BOM_NODE on the shortcut menu to open the following screen.

2. If any mappings between properties were defined when creating the mapping to

P3DGenericSystem in the last step, click Map Properties first to open the Retrieve Map. Remove all property mappings.

3. Return to the screen shown above, and remove the P3DGenericSystem classdef from the Retrieve from EF class/interface list.

4. Close the screen and save your work.

See Also SmartPlant Materials BOM Nodes (on page 28)

SmartPlant Materials BOM Positions SmartPlant Materials identifies retrieved material by the catalog part number, except for BoltSets and gaskets, which will be identified by commodity code and sizes. Of course, this kind of material must already be available in the SmartPlant Materials material library. In the delivered map file, piping material defined by the following class definitions will be processed and placed below their system items accordingly. P3DPipe P3DPipingComponent P3DPipeInstrument P3DPipeBoltSet P3DPipeGasket

Page 41: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 41

The default mapped class definitions and map properties are shown below.

The following map properties are reserved for later use and should not be mapped at the moment: BOM_Pos_Group_Code BOM_Pos_Option_Code BOM_Pos_Part_Code BOM_Pos_Short_Code

SmartPlant Materials BOM positions are represented by the MARIAN_BOM_POS SPMapClassDef. To edit this SPMapClassDef, open the Retrieve Map. The procedure to do this operation has already been described in the example of editing the MARIAN_BOM_NODE in the section above.

Page 42: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

42 SmartPlant Materials Adapter and Integration Configuration Guide

P3DPipe

Map the BOM_Pos_Ident map property to the CatalogPartNumber property. This mapping is mandatory and should not be changed or removed. Map the BOM_Pos_Quantity map property to the StockPart_CutLength property. SmartPlant Materials interprets the length of the pipe as the quantity to purchase for this kind of pipe. Mapping of BOM_Pos_Quantity is mandatory and should not be removed, but it is possible to map to another property of P3DPipe, for example, StockPart_Length.

Page 43: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 43

P3DPipeInstrument and P3DPipingComponent

For both class definitions, the BOM_Pos_Ident map property maps to the CatalogPartNumber property. This mapping is mandatory and should not be changed or removed.

There is no need to map BOM_Pos_Quantity. The quantity of retrieved material of both class definitions will be interpreted as 1 for each occurrence.

Page 44: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

44 SmartPlant Materials Adapter and Integration Configuration Guide

P3DPipeBoltSets

Bolts, nuts, and washers are identified in SmartPlant Materials by commodity codes and sizes. Therefore, the mapping of BoltSets is mandatory as shown in the graphic above.

Page 45: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 45

P3DPipeGaskets

Gaskets will be identified in SmartPlant Materials by commodity codes and sizes. Therefore, the mapping of gaskets is mandatory as shown in the graphic above.

See Also Mapping for BOM Retrieve from SmartPlant 3D (on page 28)

SmartPlant Materials Tagged Items SmartPlant Materials tagged items are represented in the tool schema by the MARIAN_BOM_POS_TAG SPMapClassDef.

Page 46: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

46 SmartPlant Materials Adapter and Integration Configuration Guide

To edit this SPMapClassDef, open the Retrieve Map. The procedure to perform this operation has already been described in the example of editing the MARIAN_BOM_NODE in the section above.

SmartPlant Materials uses a tag number and a tag description when creating a tagged item on the BOM. The map properties created for this purpose are BOM_Pos_Tag_Number and BOM_Pos_Tag_Description. By default, BOM_Pos_Tag_Number maps to the Name property of the IObject interface, and BOM_Pos_Tag_Description maps to CatalogPartNumber. The following map properties are reserved for later use and should not be mapped at the moment: BOM_Pos_Groupcode BOM_Pos_Optioncode BOM_Pos_Partcode BOM_Pos_Shortcode BOM_Pos_Tag_Platenumber

See Also Mapping for BOM Retrieve from SmartPlant 3D (on page 28)

Page 47: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 47

Additional Attributes SmartPlant Materials is able to store additional attributes to nodes and positions. As already mentioned, the default map file is delivered without a mapping to attributes. Each customer will be interested in a different attribute set and therefore must define the mapping himself. This task is described below for MARIAN_BOM_NODE_ATTRIBUTE. You can proceed with mapping attributes for positions and tagged items in the same way by editing MARIAN_BOM_POS_ATTRIBUTE and MARIAN_BOM_POS_TAG_ATTRIBUTE.

See Also Mapping for BOM Retrieve from SmartPlant 3D (on page 28)

Node Attributes

MARIAN_BOM_NODE_ATTRIBUTE It only makes sense to define a mapping to attributes for nodes if the classdefs are also mapped to be retrieved as a BOM node. So MARIAN_BOM_NODE_ATTRIBUTE will usually map to the same class definitions as defined for MARIAN_BOM_NODE.

To edit this SPMapClassDef, open the Retrieve Map. The procedure to perform this operation has already been described in the example of editing the MARIAN_BOM_NODE in the section above.

Page 48: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

48 SmartPlant Materials Adapter and Integration Configuration Guide

The example given is for mapping attributes to the P3DPipelineSystem and must be done for all affected class definitions in the same way. When edited for the first time, the map looks like the following:

Browse through the list of properties. If a property of interest is found, simply drag and drop the BOM_Node_Attr_value map property to the Map Property Def column of the corresponding row. Continue in the same way for all necessary properties.

Page 49: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 49

The following graphic shows the FluidSystem, FluidCode, and SP3D_ApprovalStatus properties mapped.

Repeat these steps for other class definitions. Then, close the window and save your work.

See Also Additional Attributes (on page 47)

Position Attributes

MARIAN_BOM_POS_ATTRIBUTE and MARIAN_BOM_POS_TAG_ATTRIBUTE For position items, it only makes sense to define a mapping to attributes to be attached if the classdefs are also mapped to be retrieved as a position item. So MARIAN_BOM_POS_ATTRIBUTE will usually map to the same class definitions as defined for MARIAN_BOM_POS.

Page 50: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

50 SmartPlant Materials Adapter and Integration Configuration Guide

Note that the mapping procedure is the same for MARIAN_BOM_POS_TAG_ATTRIBUTE, but the following graphics show MARIAN_BOM_POS only.

To edit this SPMapClassDef, open the Retrieve Map. The procedure to perform this operation has already been described in the example of editing MARIAN_BOM_NODE in the section above. The example given is for mapping attributes to P3DPipe and must be done for all affected class definitions in the same way.

Page 51: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 51

When edited for the first time, the map looks like the following:

Browse through the list of properties. If a property of interest is found, simply drag and drop the BOM_Pos_Attribute map property to the Map Property column of the corresponding row. Continue in the same way for all necessary properties.

Page 52: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

52 SmartPlant Materials Adapter and Integration Configuration Guide

The following graphic shows the mapped SP3D_DateLastModified and SP3D_ApprovalStatus properties.

See Also Additional Attributes (on page 47)

Page 53: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 53

Mapping for BOM Retrieve from SmartPlant Isometrics The mapping delivered with the MTI-S installation allows you to retrieve data from the default SmartPlant Isometrics class definition PODPipeline as BOM nodes and BOM positions. Mapping additional attributes for nodes and positions will not be explained in this section. At this point in time, POD documents do not contain published properties that would make good candidates as node or position attributes.

An overview of default mappings can be found in the MapPropSPMat2008--6-3-1.xls file that resides in the MarianAdapter\MapSchema\ folder according to the path chosen during installation of MTI-S. The following sections will describe the default mapping and explain how to customize the mapping.

It is recommended to make a backup copy before changing the SmartPlant Materials map schema. Changes should also be well-documented.

See Also SmartPlant Materials BOM Nodes (on page 53) SmartPlant Materials BOM Positions (on page 55) Additional Attributes (on page 59)

Page 54: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

54 SmartPlant Materials Adapter and Integration Configuration Guide

SmartPlant Materials BOM Nodes The POD Document published by SmartPlant Isometrics contains only one class definition to be mapped as a node. Isometric sheet information is stored on the position level but will automatically be used to create additional nodes below the pipeline they belong to. To edit this SPMapClassDef, select Edit MARIAN_BOM_NODE on the shortcut menu available by right-clicking the item.

On the next screen, click Retrieve Map.

Page 55: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 55

As a result, the Retrieve Map screen opens, and you can view the mapping from MARIAN_BOM_NODE to the PODPipeline classdef .

Each object’s UID and name are always stored and used during processing. The Name property is always used as the BOM Node name in SmartPlant Materials. There is no need to map to those properties. Mapping of BOM_Node_Description and BOM_Node_ShortDesc to the Name and Description properties is optional. If they are mapped and the value of the property is published, this information will go into the NLS Short Description and Description BOM nodes in SmartPlant Materials. To remove the default mapping to the Name and Description properties, follow the examples given in the Change Mapping of BOM_Node_ShortDesc or BOM_Node_Description (on page 32) section.

See Also Mapping for BOM Retrieve from SmartPlant Isometrics (on page 53)

Page 56: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

56 SmartPlant Materials Adapter and Integration Configuration Guide

SmartPlant Materials BOM Positions In the delivered map file, piping material defined by the following class definitions is processed and placed below their pipeline and isometric sheet items accordingly. PODPipe PODPipeClamp PODPipingComponent PODPipeBoltSet PODPipeGasket

The default mapped class definitions are shown below.

SmartPlant Materials BOM positions are represented by the MARIAN_BOM_POS SPMapClassDef. To edit this SPMapClassDef, open the Retrieve Map. The procedure to perform this operation has already been described in the example of editing the MARIAN_BOM_NODE in the section above.

Page 57: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 57

PODPipe

Map the BOM_Pos_Ident map property to the CatalogPartNumber property. This mapping is mandatory and should not be changed or removed. As a prerequisite, POD Documents must be published using SmartPlant Reference Data ident codes. Map the BOM_Pos_Quantity map property to the StockPart_CutLength property. SmartPlant Materials interprets the length of the pipe as the quantity to purchase for this kind of pipe. Mapping of BOM_Pos_Quantity is mandatory and should not be removed, but it is possible to map to another property of PODPipe, for example, StockPart_Length, should the value be published. Map the BOM_Pos_SpecCode map property to the PipingMaterialClass property. SmartPlant Materials transfers this information to evaluate the parts with the specification. Map the BOM_Pos_Implied_Node map property to the IsometricSheetNumber property. This information on the position level is used by SmartPlant Materials to create isometric sheets as BOM nodes.

Page 58: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

58 SmartPlant Materials Adapter and Integration Configuration Guide

PODPipeClamp, PODPipeGasket, and PODPipingComponent

For all three class definitions, the BOM_Pos_Ident map property maps to CatalogPartNumber. This mapping is mandatory and should not be changed or removed. Map the BOM_Pos_SpecCode map property to the PipingMaterialClass property. SmartPlant Materials transfers this information to evaluate the parts with the specification. Map the BOM_Pos_Implied_Node map property to the IsometricSheetNumber property. This information on the position level is used by SmartPlant Materials to create isometric sheets as BOM nodes.

There is no need to map BOM_Pos_Quantity. The quantity of retrieved material of these class definitions will be interpreted as 1 for each occurrence.

Page 59: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

SmartPlant Materials Adapter and Integration Configuration Guide 59

PODPipeBoltSet

Map the BOM_Pos_Ident map property to the CatalogPartNumber property. This mapping is mandatory and should not be changed or removed. As a prerequisite, POD Documents must be published using SmartPlant Reference Data ident codes. Map the BOM_Pos_Quantity map property to the BoltQuantity property. Mapping of BOM_Pos_Quantity is mandatory and should not be removed. Map the BOM_Pos_SpecCode map property to the PipingMaterialClass property. SmartPlant Materials transfers this information to evaluate the parts with the specification. Map the BOM_Pos_Implied_Node map property to the IsometricSheetNumber property. This information on the position level is used by SmartPlant Materials to create isometric sheets as BOM nodes.

See Also Mapping for BOM Retrieve from SmartPlant Isometrics (on page 53)

Additional Attributes SmartPlant Materials is able to store additional attributes to nodes and positions. At the moment, there are no properties published with POD Documents that would make good candidates to be stored as node attributes or position attributes. More attributes may be published in the future and there may be a need to do the mapping then. This task is described in the Additional Attributes (on page 47) section for SmartPlant 3D.

See Also Mapping for BOM Retrieve from SmartPlant Isometrics (on page 53)

Page 60: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Mapping

60 SmartPlant Materials Adapter and Integration Configuration Guide

Page 61: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

SmartPlant Materials Adapter and Integration Configuration Guide 61

The MTI-DB is the necessary data store for MTI-S and MTI-UI. In a typical integration scenario, only one MTI-DB is allowed. The MTI-DB collects processing information and publishable documents from one or more integrated SmartPlant Materials databases.

See Also Introduction (on page 7)

MTI-DB Installation This section describes the necessary steps for a fresh install of MTI-DB. Customers who have already used a MTI version prior to 7.0.0 should refer to the MTI-DB Migration from 6.3.8 to 7.0.0 (on page 71) section. An Oracle 11gRel2 Database (patch set 11.2.0.1.0) with MTI and MTI_INDEX tablespaces is required to install MTI-DB. We recommend creating a new database for this purpose. The location of the database can be on a different machine, as long as it can be accessed by SQL*Net. The necessary entries in the tnsnames.ora file have to be done on the client that is running MTI-UI and the client that hosts the MTI-S. Please refer to the Oracle database documentation on how to create an Oracle database properly. If the database is available, the necessary installation steps are to create the tablespaces, create user MTI_SYS, and create the MTI_SYS schema objects.

Install the necessary software Run browser.exe from the root node to open the SmartPlant Materials 2011 starting screen.

MTI-DB

Page 62: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

62 SmartPlant Materials Adapter and Integration Configuration Guide

Click SmartPlant MTI Installation.

Click MTI Installation Guide to review or print installation instructions.

Page 63: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

SmartPlant Materials Adapter and Integration Configuration Guide 63

Click MTI-DB Installation to start the installation of the required files for creation of the MTI database.

Page 64: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

64 SmartPlant Materials Adapter and Integration Configuration Guide

Click Next when the MTI-DB - InstallShield Wizard appears.

Page 65: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

SmartPlant Materials Adapter and Integration Configuration Guide 65

Enter your name and the name of your company, and then click Next.

Page 66: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

66 SmartPlant Materials Adapter and Integration Configuration Guide

Click Change to specify an installation path.

Choose a path, for example, C:\MTI, and then click OK. Click Next to confirm the destination location.

Page 67: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

SmartPlant Materials Adapter and Integration Configuration Guide 67

Click Install to start the installation.

Page 68: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

68 SmartPlant Materials Adapter and Integration Configuration Guide

Click Finish to end the installation procedure.

As a result, you will find a folder named dbserver in the installation path containing the necessary files for MTI database creation.

Create the tablespaces The \MTI\dbserver\ subdirectory contains a file named 000_Create_TS_MTI.sql. Edit this file to set the proper location for the data files of the MTI and MTI_INDEX tablespaces.

Create user MTI_SYS After creation of the database and the tablespaces, edit the setting for the MTI_SYS user: Open the 010_MTI_SYS_create_user.sql script with an editor. Set the values in the create user command.

Page 69: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

SmartPlant Materials Adapter and Integration Configuration Guide 69

CREATE USER mti_sys IDENTIFIED BY <password> DEFAULT TABLESPACE MTI TEMPORARY TABLESPACE <TEMP> Change <password> to your password. Change <TEMP> to the proper name of the database's temporary tablespace. Save and close the file. Edit the Start in property of an ORACLE SQL*Plus link to point to the dbserver subdirectory in the MTI directory:

Start SQL*Plus and connect as user sys.

Page 70: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

70 SmartPlant Materials Adapter and Integration Configuration Guide

Run the 010_MTI_SYS_create_user.sql script.

Enter the password for user SYS when prompted, and press Enter. Enter the database TNS alias for the new MTI database, and press Enter. The result should look like this:

Check the installation log file named \dbserver\CREATE_MTI_SYS.LST for errors.

Create MTI_SYS schema objects Create schema objects for user MTI_SYS by running the 030_mti_install.sql script.

Apply the MTI_SYS password and database alias when prompted, and press Enter.

Page 71: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

SmartPlant Materials Adapter and Integration Configuration Guide 71

As a result, the screen should look like the following:

Exit SQL*Plus and check the installation log file named \dbserver\MTI_install.lst for errors. Keep the log files in a safe place.

See Also MTI-DB (on page 61)

MTI-DB Migration from 6.3.8 to 7.0.0 This section describes the necessary steps to migrate an already existing MTI-DB of version 6.3.8 to version 7.0.0.

Page 72: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

72 SmartPlant Materials Adapter and Integration Configuration Guide

Run the migration script If not already done, switch to folder MTI_MIG in the installation path, for example, C:\MTI\dbserver\MTI_MIG\, as in the following graphic:

The \MTI\dbserver\MTI_MIG\ subdirectory contains a file named mti_mig_700.sql. To start the migration, use this file as described below.

Page 73: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

SmartPlant Materials Adapter and Integration Configuration Guide 73

Edit the Start in property of the ORACLE SQL*Plus link to point to the MTI_MIG subdirectory, which is in the MTI\dbserver\ directory:

Start SQL*Plus, and connect as user sys.

Page 74: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-DB

74 SmartPlant Materials Adapter and Integration Configuration Guide

Run the mti_mig_700.sql script.

Enter the password for user MTI_SYS when prompted, and press Enter. Enter the database TNS alias for the existing MTI database, and press Enter. The result should look like this:

Check the migration log file named \dbserver\MTI_MIG\MTI_mig_700.lst for errors. Keep the log files in a safe place.

Page 75: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

SmartPlant Materials Adapter and Integration Configuration Guide 75

The Materials Tool for Integration User Interface (MTI-UI) is an independent Oracle Forms application for administrative use with the MTI database. It allows the user to integrate all accessible SmartPlant Materials databases within one single integrated environment.

See Also Introduction (on page 7)

MTI-UI Installation When installing SmartPlant Materials, the necessary files for MTI-UI are copied to the SmartPlant Materials application server. After you install SmartPlant Materials, edit the formsweb.cfg file on the application server. Add an entry for MTI-UI as in the following example: [SPMat_MTI] pageTitle=SmartPlant Materials MTI-UI # Forms applet archive setting for other clients (Sun Java Plugin, Appletviewer, etc) archive=frmall_2010.jar,spmaticon.jar # Other Forms runtime arguments: grouped together as one parameter. # These settings support running and debugging a form from the Builder: otherparams=obr=%obr% record=%record% tracegroup=%tracegroup% log=%log% term=%term% ssoProxyConnect=%ssoProxyConnect% WebUtilArchive=frmwebutil.jar,jacob.jar WebUtilLogging=off WebUtilLoggingDetail=normal WebUtilErrorMode=Alert WebUtilDispatchMonitorInterval=5 WebUtilTrustInternal=true WebUtilMaxTransferSize=16384 baseHTML=webutilbase.htm baseHTMLjpi=webutiljpi.htm workingDirectory=< your installation directory >\SPMAT\SPMAT\fmx form=mti.fmx # userid=mti_sys/<your password>@<your database> separateFrame=True lookandfeel=Generic width=1280 height=960 splashScreen=SPMaterials_SPlash2011_b.png logo=INGR.jpg background=SPMaterials_SPlash2011.png

The value for workingDirectory points to the location where the SmartPlant Materials folder named fmx is located.

MTI-UI

Page 76: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

76 SmartPlant Materials Adapter and Integration Configuration Guide

For more information about configuring the SmartPlant Materials application server, refer to the SmartPlant Materials Installation and Migration Guide, available from Help > Printable Guides in the software. Add a link to your web browser that points to your configuration. It might look like this: http://<your_AppServerName>/forms/frmservlet?config=MTI where <your_AppServerName> is to be replaced with the name of your SmartPlant Materials application server, and <MTI> must match the entry you just added to the configuration file in the previous step. Log on as user MTI_SYS with the appropriate password and database.

See Also MTI-UI (on page 75)

Page 77: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 77

MTI-UI Configuration Do the necessary configuration steps by using screens located on the Administration menu.

See Also MTI-UI (on page 75)

Common Configuration Tasks MTI 10.01 SmartPlant Parameters This screen allows you to set basic configuration parameters to access the integrated environment from within MTI.

Page 78: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

78 SmartPlant Materials Adapter and Integration Configuration Guide

Enter the connection information to your SmartPlant environment here. Supply a valid URL, username, and password.

SmartPlant URL Valid URL for integration, for example, http:\\SPFServer.ingrnet.com\SPFASP. Ask your SmartPlant administrator for the correct URL.

SmartPlant User and Password Name of the SmartPlant login account. Enter a username and password for MTI to connect to SmartPlant. Depending on the plants the user is allowed to access in SmartPlant, MTI access to plant data is restricted also. It is recommended to define a user within SmartPlant who has access to any plant. The password of the SmartPlant account must be stored here if the account requires a password to allow a login to SmartPlant without user interaction.

Active Defines if this URL may be used as the current SmartPlant environment. For the current version, only one active record is allowed. Configurations cannot be switched once the integration has been started.

See Also MTI-UI Configuration (on page 77)

Page 79: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 79

MTI 10.11 SmartPlant Materials Projects With this screen, you can manage the database links to the SmartPlant Materials databases that are part of the SmartPlant integration. Depending on the database link, the SmartPlant Materials projects mapped to SmartPlant plants are shown.

SmartPlant Materials Databases Create the database links to the SmartPlant Materials databases that are part of the integration. Once the database link is established and the SmartPlant Materials database passes the compatibility check, you can retrieve SmartPlant Materials projects by clicking the Refresh Projects button. It is strongly recommended to get the advice of your database administrator to complete this task.

Link Name Apply a valid link name according to Oracle guidelines (for example, no special characters or blanks).

Do not use a link name that equals the TNS entry or the target database SID. This may cause Oracle to produce an error when creating or using the database link.

Page 80: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

80 SmartPlant Materials Adapter and Integration Configuration Guide

Active Checking or unchecking this check box determines if the database link is currently part of the integration or not. All mappings to projects of this database are kept, but temporarily will not be part of any processing. This functionality can be used to maintain planned downtimes, for example, for maintenance purposes.

Valid This check box is to inform the user about the current state of the database link. If the check box is checked, the database link can be used. If not, check column error messages to find out the reason of invalidation.

Description User-definable description of the database link or target database.

Link Hostname Name of the host where the SmartPlant Materials database resides and the database link points to.

Link Using Using parameter of the link creation syntax. This will be used while creating the link. Corresponds to the TNS entry in tnsnames.ora on the database server where the database link is to be created.

Link User Name of the user that is used to establish the database link. Use M_SYS as user of the link.

Error Message Error message while creating or using the link. Interpret this error message to examine why the link is not in a valid state. Note that in order to allow MTI to keep track which documents have been retrieved from SmartPlant and are already transferred to SmartPlant Materials databases, it is not allowed to change the database link. If the physical link must be re-directed, use the same DB Link record again. Drop the physical link by using the Drop DB Link button, update the necessary parameters, and click Create DB Link afterwards.

Drop DB Link When you click this button, MTI drops the physical database link of the current record. The record will be deleted also if no data exchange for the dependent projects has been done so far. Otherwise, the record will be set to Active = No.

Check DB Link When you click this button, MTI checks the state of the SmartPlant Materials target database that the physical database link points to. If the check fails, the Valid check box will be unchecked. Compatibility checks will be done for the database NLS parameters, the SmartPlant Materials version, and Service Packs.

Page 81: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 81

Refresh Projects When you click this button, MTI tries to open the current database links and search for projects not yet transferred to MTI-DB. It will also fetch all SmartPlant Materials disciplines belonging to the projects.

Commit the changes first, and then click the Create DB Link button.

Click Yes. Check the Error Message column for errors and for how to resolve them.

Page 82: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

82 SmartPlant Materials Adapter and Integration Configuration Guide

If the database creation was successful, the Error Message column should look like this:

To connect to SmartPlant Materials projects in this database, the Active check box must be checked and saved. Otherwise, the Refresh Projects button will not become active.

See Also MTI-UI Configuration (on page 77)

Page 83: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 83

SmartPlant Materials Projects Depending on the database link, the available SmartPlant Materials projects are retrieved and displayed after you click the Refresh Projects button. By checking or unchecking the Active check box, the project becomes available or unavailable for mapping with SmartPlant plants or projects.

Active An indicator showing whether the project is used for the current MTI integration scenario.

Project/Product Group Code that specifies the SmartPlant Materials project in the linked SmartPlant Materials database.

Comments Freely definable user comments on this project. The value does not affect processing.

See Also MTI-UI Configuration (on page 77)

Page 84: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

84 SmartPlant Materials Adapter and Integration Configuration Guide

MTI 10.12 SPF Plants and Projects With this screen, the plants and projects of a SmartPlant integration environment are shown. Users can make plants and projects active. Active projects are available for mapping to SmartPlant Materials projects. When starting integration, no plants or projects are shown on this screen.

Retrieving SmartPlant plants and projects Clicking the Get Plants or Register buttons causes MTI to schedule a new workload record of the appropriate type. The schedule is determined by values applied to the First Start Time, Schedule Factor, and Schedule Unit fields. If only a First Start Time value is entered and the Schedule Factor box remains empty, the workload record is scheduled to be executed at the specified time only once. By entering a value in the Schedule Factor box, a recurrently scheduled workload record can be defined. For detailed information on how to manage scheduled workload records, refer to the explanations of the MTI 90.11 Workload screen.

Get Plants Clicking this button creates a new entry in the MTI workload of type GetPlants.

Page 85: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 85

If this command is executed, the software queries SmartPlant for available plants and stores all plants to MTI-DB, if not already stored.

Register Clicking this button creates a new entry in the MTI workload of type Register. If this command is executed, the software registers all unregistered plants that are marked as Active. Starting an integration requires that a workload record of type GetPlants is scheduled first. MTI-S must be up and running to fetch and execute this workload record. To see the results, the screen must be re-queried. The result may look like this:

The meaning of the displayed fields displayed in the first block is as follows:

Plant Name The name of a particular SmartPlant plant that SmartPlant Materials registers a dummy plant with.

Register Indicator showing if this plant is a candidate to register.

Page 86: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

86 SmartPlant Materials Adapter and Integration Configuration Guide

Active By checking or unchecking this check box, you can determine if this plant and all depending data will be part of the integration.

Signature After registration, the returned signature is stored here for future connections.

SPMat Dummy Plant This is a SmartPlant Materials composed dummy value for registration purposes only.

See Also MTI-UI Configuration (on page 77)

Registering SmartPlant Materials with SmartPlant Plants Choose the plants of interest by selecting the Active and Register check boxes.

Page 87: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 87

Click Register to initiate a new workload record of the Register type to be scheduled.

The screen above shows the new scheduled record with the REGISTER command and the already processed GETPLANTS command. Again, MTI-S will execute the workload record with a due schedule.

Page 88: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

88 SmartPlant Materials Adapter and Integration Configuration Guide

After the REGISTER command has been executed, the result can be viewed.

The chosen plant has been registered and the projects have been retrieved and are shown in the SmartPlant Projects block.

SmartPlant Projects

Active Mark the projects of a plant as active by checking the check box. Only projects marked as active are part of the integration and are available for mapping with document types to retrieve or publish.

Project Name and Project UID Project Name and UID as retrieved from SmartPlant are used to establish a connection to SmartPlant if mapping is defined. The mapping requires connecting to the projects directly.

Status If the connection to SmartPlant is scoped by a project, the status of the project is copied to this column. This is for later use and not completed properly yet.

Page 89: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 89

See Also MTI-UI Configuration (on page 77)

MTI 10.13 Plant/Project Mappings With this screen, you can configure the mapping between SmartPlant plants/projects and SmartPlant Materials projects. This mapping specifies the SmartPlant plants or projects from which documents are retrieved and the SmartPlant Materials projects to which documents are published. This configuration step is necessary because only mapped projects are part of the integration.

Manage Plant/Project Mappings This block shows all active SmartPlant plants and projects of the plants.

Mappings to SPMat Projects Use the List of Values to choose the SmartPlant Materials projects that should map to the SmartPlant plant or project.

Order Seq This mandatory Sequence Number determines the processing order of the projects while retrieving or publishing. At the moment, it is not allowed to map more than one SPMat project to

Page 90: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

90 SmartPlant Materials Adapter and Integration Configuration Guide

a single SPF plant/project. Therefore, the Order Seq is without further consequence to the processing.

Project SmartPlant Materials Project in the linked SmartPlant Materials database.

PGrp An indicator showing if the SmartPlant Materials project is a product group.

Retrieve Docs An indicator showing if the linked SmartPlant Materials database is used for retrieve of document headers.

Retrieve BOM An indicator showing if the linked SmartPlant Materials database is used for retrieve of BOM data.

Publish Req / PO An indicator showing if the linked SmartPlant Materials database is used for publishing the Requisition / Purchase Order data.

Publish / Retrieve LL An indicator showing if the linked SmartPlant Materials database is used for publishing or retrieving the Line List data.

SPMat Database Name of the database link to the SmartPlant Materials database.

Valid Shows if the database link to this SmartPlant Materials database is in a valid state.

SPMat Discipline Default SmartPlant Materials discipline to be used for this mapping while processing the different document types. Disciplines added to document types (MTI 10.22 Document Type Mappings) overwrite the value of the discipline chosen here.

Last Processed Timestamp of the last processing of this mapping record. Follow this example to define a mapping between SmartPlant plants or projects and SmartPlant Materials projects.

Page 91: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 91

Choose a record in the upper block to specify the SmartPlant plant or project. Switch to the lower block, apply an Order Seq, and open the pick list for available SmartPlant Materials projects (for example, by pressing F9 on the keyboard).

Select a project, and confirm by clicking OK.

Page 92: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

92 SmartPlant Materials Adapter and Integration Configuration Guide

Add a default SmartPlant Materials discipline by choosing from the pick list.

Page 93: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 93

When transferring documents to SmartPlant Materials, this discipline will be used as a default for all documents, unless another discipline is specified on MTI 10.22 Document Type Mappings.

The mapping just defined will be used to define the document types to retrieve from SmartPlant.

See Also MTI-UI Configuration (on page 77)

Configure Document Retrieval MTI 10.21 SPF Document Type Hierarchy The purpose of retrieving and selecting from the document type hierarchy is to restrict the amount of data that is to be queried, stored, and transferred. The more document types that are chosen, the more resources will be consumed by processing the retrieve.

This configuration step applies to document header retrieval only. BOM data retrieval is not affected by these settings.

Page 94: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

94 SmartPlant Materials Adapter and Integration Configuration Guide

When starting the integration, the document type hierarchy is not available in MTI.

To get the hierarchy from SmartPlant, a workload record must be scheduled first. Click Refresh Hierarchy. This action will add the necessary workload record with the GETDOCHIER command.

Page 95: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 95

After the execution of this command by MTI-S, refresh the screen. The entire document type hierarchy will be displayed.

Now users can browse all categories, document types, and subtypes retrieved from SmartPlant. Check the check boxes to mark categories, document types, and subtypes as active. Only active records will be available for retrieval and for mappings of document types to projects. An inactive Document Category will automatically deactivate all underlying document types and subtypes. In the same way, a deactivated Document Type will exclude all underlying subtypes from mapping.

Page 96: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

96 SmartPlant Materials Adapter and Integration Configuration Guide

Note that if a document type is first active and then used for mapping and at a later point in time is deactivated on this screen, it won't be retrieved anymore even if the mapping remains.

By default, all categories and all document types are active. This means that all document types are available for mapping. Activate or deactivate the categories, document types, and subtypes of interest by clicking the appropriate check boxes or use the Activate All and Deactivate All buttons.

Activate All Click this button to set all Categories, Document Types, and Subtypes to active. The block that is affected depends on where the cursor is placed before you clicked the button.

Deactivate All Click this button to set all Categories, Document Types, and Subtypes to inactive (uncheck check box). The block that is affected depends on where the cursor is placed before you clicked the button.

Refresh Hierarchy This button initiates a re-query of the Document Categories, Document Types, and Subtypes from the SmartPlant environment. This action is only necessary if you know that some changes regarding the Document Type Hierarchy have been made in SmartPlant. Alternatively, users can make this task an automated recurring action by entering values in the Schedule Factor and

Page 97: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 97

Schedule Unit boxes. The result of the hierarchy refresh will be shown with a time difference, depending on how busy MTI currently is. Re-query this screen to see the results.

MTI 10.22 Document Type Mappings On this screen, users decide which Document Types each SmartPlant Materials project is provided with. Users must also choose a SmartPlant Materials discipline for each Document Type.

Note that the categories, document types, and subtypes shown in the tree are determined by the Active settings on MTI 10.21 SmartPlant Document Types. Follow these instructions to define a mapping of document types to retrieve: 1. Under Mapped Plants and Projects, choose the applicable SPF Plant record for which you

want to define a document type mapping. The check boxes indicate if the record is activated to be part of the integration.

2. Browse the document type hierarchy tree in the left pane and mark a category, document type, or subtype of interest, for example, 3D Documents – Electrical, or Bills of Materials Documents to retrieve file-based material takeoff reports. Note that only one selected node is allowed at a time. Navigate the tree, and expand or collapse the nodes by using the buttons in the navigator pane or by double-clicking.

Page 98: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

98 SmartPlant Materials Adapter and Integration Configuration Guide

It is possible to search for Document Types by applying search criteria below the tree. Click the search button with the question mark in the navigator pane. Starting the search will locate the first Document Category, Document Type, or SubType that matches the search criteria.

3. Click Copy in the navigator control (shows an arrow to the right). This action maps the

Document Types to the project selected in the previous step.

The document type and all of its subtypes have been copied to the lower right block.

Page 99: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 99

4. Under the Retrieve Adapter column, select the adapter type to retrieve. When you select the Retrieve Adapter, this type of data to be retrieved in an integrated environment. The retrieve adapter field is protected against update for the existing document type mappings. For example, for PBS Documents types, the PBS is automatically selected in the Retrieve Adapter field. This selection is non-modifiable. But, If you map the General Document type, several adapter types can be selected from the list as the retrieve type.

5. Change the discipline for each record according to your needs, or keep the default. 6. Repeat these steps until the necessary document types are all mapped. 7. Schedule the document retrieval after the mapping is defined. To do this, specify values in the

First Start Time, Schedule Factor, and Schedule Unit fields. 8. Click one of the following:

Add to workload - Documents to add the appropriate command to the workload. For example, When you map the document type PBS Documents with PBS selected in the

Retrieve Adapter column, and then click Add to workload – Documents, the command RETRIEVEPBS is added to retrieve PBS documents.

When you map the document type Line List with Line List selected in the Retrieve Adapter column, and then click Add to workload – Documents, the command RETRIEVE_LL is added to retrieve Line List documents.

When you map the document type 3D Bill of Materials with BOM File Based selected in the Retrieve Adapter column, and then click Add to workload – Documents, the command RET_FILE_DOC is added to retrieve BOM file-based documents.

When you map the document type SmartPlant Review Document or POD Document with BOM selected in the Retrieve Adapter column, and then click Add to workload – Documents, the command RETRIEVEBOM is added to retrieve BOM documents.

When processed by MTI Service, the command retrieves the appropriate documents. Add to workload - Doc Headers to add the command GETDOCUMENTS to the

workload, When processed by MTI Service, the command retrieves the document headers.

The workload can be checked and changed on MTI 90.11 Workloads. To define the retrieval of documents for other projects, continue with another record of Mapped Plants and Projects in the same way. Note that each SmartPlant plant or project has its own schedule defined.

Page 100: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

100 SmartPlant Materials Adapter and Integration Configuration Guide

MTI 10.25 SmartPlant Enterprise Retrieved Documents On this screen, users view document header information and the Plant Breakdown Structure (PBS) documents retrieved. The Retrieved Document Headers tab shows the retrieved document headers, including the Document Type, Revision and Version information, and the Status of the retrieval.

The Retrieved PBS Documents tab shows the retrieved PBS Documents including the Revision and Version information, and the Status of the retrieval.

Page 101: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 101

Configure SmartPlant Materials Publish MTI 10.31 SmartPlant Materials Publish Types This screen shows all available SmartPlant Materials document types for publish. To be part of the integration, the document types must be set to Active by selecting the appropriate check box.

SP Materials Publish Types Name and UID of SmartPlant Materials-publishable document types.

Active Defines if this SmartPlant Materials document type is available for mapping on MTI 10.32 SmartPlant Materials Publish Type Mappings.

Page 102: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

102 SmartPlant Materials Adapter and Integration Configuration Guide

MTI 10.32 SmartPlant Materials Publish Type Mappings This screen allows users to specify which SmartPlant Materials document types (Requisitions for Purchase, Requisitions for Inquiry, Purchase Order, or Line List Calculation) are to be published for each mapping of a SmartPlant Materials project to a SmartPlant plant/project..

Mapped Plants and Projects Choose the mapped SmartPlant Materials project and SmartPlant project for which you want to define a mapping of SmartPlant Materials publishable document types. The meaning of the displayed fields is the same as for screen MTI 10.22 Document Type Mappings and will not be explained here. For more information, refer to the above explanations for screen MTI 10.22 Document Type Mappings, or refer to the online help.

Publish Type Mappings This block shows the SmartPlant Materials publishable document types, which are already selected for this mapping. These records will not be displayed anymore in the block of available publish types.

Publish Types Shows only the SmartPlant Materials publishable document types that are not already selected for this mapping. To add the displayed publishable document types to the mapping, use the Copy All or Copy buttons.

Page 103: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 103

Copy All Clicking this button copies all SmartPlant Materials publishable document types not mapped yet to the Publish Type Mappings block.

Copy Clicking this button copies the SmartPlant Materials publishable document type at the current cursor position to the Publish Type Mappings block. The effect of using the buttons looks like this:

Use the Add to workload button to schedule the publishing of mapped types from the displayed SmartPlant Materials database to the SmartPlant plant or project.

Page 104: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

104 SmartPlant Materials Adapter and Integration Configuration Guide

Configure BOM Data Retrieval MTI 10.41 BOM Doc Type Mappings

This screen allows users to specify which SmartPlant Materials document types (SmartPlant Review Document, POD Document) are to be used for retrieve of BOM data for each mapping of a SmartPlant Materials project to a SmartPlant plant/project.

Retrievable Document Types for BOM This block shows all available SmartPlant Materials document types for BOM retrieve. To be part of the integration, the document types must be set to Active by checking the particular check box.

Mapped Plants and Projects Choose the mapped SmartPlant Materials project and SmartPlant project for which you want to define a mapping of document types for BOM retrieve.

BOM Document Type Mappings This block shows the document types already mapped for BOM retrieve. These records will not be displayed anymore in the block of available document types. To add the displayed document types to the mapping, use the Copy All or Copy buttons.

Page 105: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 105

Copy All Clicking this button copies all available document types not mapped yet to the BOM Document Type Mappings block.

Copy Clicking this button copies the document type at the current cursor position to the Document Type Mappings block. The effect of using the buttons looks like this:

Use the Add to workload button to schedule the retrieve of mapped types from the displayed SmartPlant Materials database to the SmartPlant plant or project.

Page 106: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

106 SmartPlant Materials Adapter and Integration Configuration Guide

MTI 10.45 Retrieved BOM Documents

This screen is used to view the retrieved BOM documents. If File Based is checked next to the corresponding document, the document is retrieved as

part of a file-based BOM documents retrieval. The Transferred field represents the status of the BOM documents.

If the status is YES, the documents have been successfully retrieved into SmartPlant Materials.

If the status is NO, the documents are not transferred to SmartPlant Materials. When the command for retrieving BOM documents is processed again by MTI-Service, it will attempt to retrieve these documents again and transfer them to SmartPlant Materials.

If your file-based BOM documents fail to transfer, check your retrieve settings, then run the retrieve again.. See File-Based BOM Retrieve Settings (on page 23).

If the status is Error, there was an error while trying to transfer the BOM documents to SmartPlant Materials.

Page 107: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 107

Control Processing MTI 90 Information This menu contains a collection of screens to inform users about the current state of the MTI environment.

See Also MTI-UI Configuration (on page 77)

MTI 90.01 Supported SmartPlant Materials Versions

This screen informs users about the SmartPlant Materials versions that are compatible with the current MTI version. Only the displayed versions of SmartPlant Materials databases are candidates for integration with MTI.

Page 108: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

108 SmartPlant Materials Adapter and Integration Configuration Guide

Future changes will be applied by installing MTI Service Packs.

MTI Supported SmartPlant Materials Versions This block lists all MTI-supported SmartPlant Materials versions and the corresponding Service Pack number. Other SmartPlant Materials versions cannot be part of the integration with MTI.

Page 109: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 109

MTI 90.11 Workload

This screen allows users to manage the MTI workload and to view the schedules and processing results.

MTIS Workloads The workload records are listed in descending order by completed date, start date, and scheduled date in this block.

Type Type of the workload record. Possible values are: DOC for document retrieval. ADM for administrative tasks like Register or Get Plants. PUB for publishing. RET for BOM and Line List documents retrieval.

Command The particular command or processing step of integration to process, for example, GETPLANTS, GETDOCUMENTS, REGISTER, and so forth..

Page 110: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

110 SmartPlant Materials Adapter and Integration Configuration Guide

Priority The priority value between 0 (default) and 99999. If all workload records of NEW status are of priority zero, the next record to be processed is determined by the scheduled date only. If some records with a due schedule are available and have a priority set, records with the highest priority will be processed first.

Status Shows the current processing state of the record. Possible values are NEW, CURRENT, PROCESSED, and ERROR. Only records of NEW status can be updated; for example, you can set the priority or define a new schedule.

Scheduled Date and timestamp of the execution schedule of the workload command. Can only be changed if the record is of NEW status.

Started at Date and timestamp set when MTI started the processing of the command.

Completed at Date and timestamp when MTI completed the processing of the command.

Schedule Factor A number value that is used together with the Schedule Unit setting to determine the next schedule of processing this command. Possible values are 1 – 999. If no value is specified, the workload record will be processed only once and not re-scheduled.

Unit A value (Days, Hours, or Minutes) that is used together with the Schedule Factor value to determine the next schedule of processing this command.

System Message A short message about the processing result.

Manage Workload

Clear Clear the workload table by clicking this button. Only records with an ERROR, PROCESSED, or CANCELLED state will be deleted. It may be necessary to clear the workload table for performance reasons, depending on how the system is set up, mainly with respect to the amount and schedule of the workload records.

Cancel Click this button to cancel a workload command that does not have a WORKING or PROCESSED status.

Page 111: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 111

Set Schedule Clicking this button sets a new execution schedule for a workload record. The schedule is defined by the values in the First Start Time, Schedule Factor, and Schedule Unit fields. Change these values according to your needs, and then place the cursor on the record to be re-scheduled. Click Set Schedule to apply the new schedule to the record.

Examples: If the Schedule Factor field is empty, the workload record will be scheduled only once,

determined by the First Start Time value. If the Schedule Factor value is, for example, 30, and the Schedule Unit value is set to

Minutes, the the workload record will be scheduled recurrently. After the workload record is processed for the first time, MTI will insert a new copy of the workload record with a scheduled date determined by the old scheduled date + 30 minutes.

A Schedule Factor value of 1 with a Schedule Unit value of Day will schedule the workload record once a day, starting first at the time specified in the First Start Time field.

A Schedule Factor value of 60 with a Schedule Unit value of Minutes will schedule the workload record every hour, starting first at the time specified in the First Start Time field.

MTI 90.21 Logging

This screen allows users to view and manage logging information written to the MTI database.

Page 112: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

112 SmartPlant Materials Adapter and Integration Configuration Guide

The contents are required by the SmartPlant Materials Service Center if customers want to report a problem with MTI.

MTIS Logs The information logged to the database by MTI processing is displayed here. The amount of logging information depends on the DBLOGLEVEL parameter in MTIS.INI. Values may be between 1 (only logging of errors) to 9 (trace all). It is recommended to use log level 9 when installing and testing MTI. Once MTI is running as needed, a lower log level should be used to save performance and disk space.

ID Sequence number of the logging table, used to display records in a descending order.

Application The application (abbreviated) that the log entry is coming from, for example, MTI-S or MTI-DB.

Timestamp Timestamp of when the record was inserted.

Page 113: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

SmartPlant Materials Adapter and Integration Configuration Guide 113

Action A short entry of the action causing the log entry.

Text Short Free format text for MTI-S logging purposes.

Text Long Free format text for MTI-S logging purposes.

Manage Logging Manages the MTI-S logging table. You can either export the table contents to a physical file or delete the table contents to prevent the logging table from consuming too much storage.

Clear Clear the logging table by clicking this button. Beware that all information will be lost.

Export Click this button to store the table contents to a physical file in the utl file directory of the database. The file will be named as follows: MTIDB_Log_xxxx.log, where xxxx is a placeholder for a continuous number. Before proceeding, the application asks you whether to delete or keep the table contents after exporting.

Page 114: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-UI

114 SmartPlant Materials Adapter and Integration Configuration Guide

Page 115: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

SmartPlant Materials Adapter and Integration Configuration Guide 115

In a SmartPlant Materials integration scenario, the MTI-S is required on a single machine only. Do not try to run more than one instance of MTI-S with one MTI-DB and one SmartPlant integrated environment.

General Requirements MTI-S can be installed on any machine, but it requires SmartPlant Client software including Schema Component and access to MTI-DB via SQL*Net.

SmartPlant SmartPlant Foundation 2009.2 (version 04.03.02) contains the necessary enhancements for

SmartPlant Materials integration that supports the full functionality available with MTI 7.0.0.0.

MTI-S and SmartPlant Materials Adapter require the installation of SmartPlant Client, SmartPlant Schema Component, and MDAC 2.81 (Microsoft Data Access Components) on the same machine.

Refer to SmartPlant documentation on how to install the necessary SmartPlant software.

Oracle Access to the Oracle Server hosting the MTI-DB. Oracle Net Services Oracle Services for Microsoft Transaction Server (release 9.0 or higher). Oracle Provider for OLE DB is included as part of your Oracle installation

Refer to ORACLE documentation for information on how to install ORACLE software.

Regional Settings Necessary settings for MTI-S and SmartPlant Materials Adapter:

MTI-S

Page 116: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-S

116 SmartPlant Materials Adapter and Integration Configuration Guide

Set the location to United States or a compatible value.

See Also Introduction (on page 7)

MTI-S Installation First Installation

Run browser.exe from the root node to open the SmartPlant Materials 2011 starting screen.

Page 117: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-S

SmartPlant Materials Adapter and Integration Configuration Guide 117

Click the SmartPlant MTI Installation option.

Click MTI Installation Guide to review or print installation instructions.

Page 118: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-S

118 SmartPlant Materials Adapter and Integration Configuration Guide

Click MTI-S Installation to start the installation of SmartPlant Materials Tool for Integration Scheduler.

Page 119: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-S

SmartPlant Materials Adapter and Integration Configuration Guide 119

Click Next when the MTI-S - InstallShield Wizard appears.

Enter your name and the name of your company, and then click Next.

Page 120: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-S

120 SmartPlant Materials Adapter and Integration Configuration Guide

Click Change to specify an installation path.

Choose a path, for example, C:\MTI, and then click OK. Click Next to confirm the destination location.

Page 121: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-S

SmartPlant Materials Adapter and Integration Configuration Guide 121

Click Install to start the installation.

Page 122: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-S

122 SmartPlant Materials Adapter and Integration Configuration Guide

Click Finish to end the installation procedure.

Upgrading from Previous Versions The necessary upgrade steps for MTI-S are as follows: 1. Make a backup copy of the existing folder where MTI-S is installed. 2. To install the current MTI-S version, you can follow the same procedure as described for a

first installation above. 3. After the installation succeeds, you must follow the instructions given in the MTI-S

Configuration (on page 122) section.

See Also MTI-S (on page 115)

Page 123: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-S

SmartPlant Materials Adapter and Integration Configuration Guide 123

MTI-S Configuration MTI-S acquires its necessary parameters by opening the MTIS.ini file and interpreting the values for each parameter. Go to the MTIS folder and open the MTIS.ini file with Notepad. The content should look like this: DEBUGLEVEL|9 ENABLED|TRUE PROVIDER|OraOLEDB.Oracle DATASOURCE|<your_DB_TNS> PASSWORD|<your_DB_password> TIMERSECONDS|20 DBLOGLEVEL|1 The meaning of the parameters is as follows:

DEBUGLEVEL This parameter determines how much information is written to the log files in the \MTIS\log\ and \MTIS\MarianAdapter\log\ folders. Values between 1 and 9 are possible, where a higher value means more information will be written. Leave the value at 9 at the beginning and switch to a lower value if MTI-S works properly.

ENABLED Possible values are TRUE or FALSE, where FALSE means that MTI-S will not start processing. Choose the FALSE value if you want to make sure that MTI-S is not started accidentally, for example, during planned database downtimes.

PROVIDER MTI-S currently works with data provider OraOLEDB.Oracle only. Do not change this value.

DATASOURCE Set the appropriate value for <your_DB_TNS>, which is the TNS entry that points to the MTI-DB.

PASSWORD Set the appropriate value for <your_DB_password>, which is the password for user MTI_SYS.

TIMERSECONDS By specifying this value, users can determine how often MTI-S will look for due workload records. Possible values are integers between 1 and 65.

DBLOGLEVEL This parameter determines how much information is written to the logging table of the MTI database. Values between 1 and 9 are possible, where a lower value means more information will be written. Leave the value at 1 at the beginning and switch to a higher value if MTI-S works properly. The contents of the logging table can be viewed by MTI-UI. Edit the file according to your needs and save the MTIS.ini file.

Page 124: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-S

124 SmartPlant Materials Adapter and Integration Configuration Guide

See Also MTI-S (on page 115)

Starting MTI-S To start MTI-S, double-click MTIS.exe in the \MTI\VB\MTIS\ folder. MTIS reads its initial configuration values from MTIS.ini and tries to connect to MTI-DB. The parameter values are displayed in the output area. If successfully connected, MTI-S looks for due workload records and process them one by one. Note that one workload record must be processed completely before MTI-S starts the next one.

MTI-S starts processing anytime the time specified by the TIMERSECONDS parameter has elapsed.

Page 125: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-S

SmartPlant Materials Adapter and Integration Configuration Guide 125

MTI-S informs the user of its working status regularly by displaying the following information.

Check the log files in the \MTIS\log\ path regularly and send log files to the SmartPlant Materials Service Center for debugging purposes if necessary.

See Also MTI-S (on page 115)

Page 126: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

MTI-S

126 SmartPlant Materials Adapter and Integration Configuration Guide

Page 127: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

SmartPlant Materials Adapter and Integration Configuration Guide 127

Managing piping as "lines" (or pipelines) using a "line list" is an industry-standard practice. Piping engineers, other project engineers, and managers typically manage key information associated with piping systems using a report/document known as a "line list". As a key coordination document, a line list includes a short record of important information about those lines. SmartPlant Foundation can publish the line list to the data warehouse through the line list document and a snapshot of the records contained in the line list. By default, SmartPlant Foundation publishes the following: The Line List Document The Line List Records contained in the line list Dynamic relationships of type NonDrawingItemCollection that are generated between the

records and the document On a republish, if a line list record is found to be terminated, a delete instruction for the record

is published in the Tombstone file On a republish, if a line list record has been flagged to be excluded from the line list or if a line

list record is found to be no longer related to the line list, a delete instruction for the relationship between the record and the document is generated and published

Data published to the data warehouse can be retrieved by SmartPlant Materials. SmartPlant Materials can then publish the wall thickness and other mapped properties, and SmartPlant Foundation can retrieve the line list with the data provided by SmartPlant Materials from the data warehouse. For line lists, SmartPlant Materials is primarily used for Checking that the specification on each line is the same in the Bill of Materials (BOM) as in

the line list. Setting the wall thickness in case this property does not come from SmartPlant 3D. Checking the nominal sizes.

In SmartPlant Materials, the properties Nominal Diameter and Wall Thickness are mapped by

default. You must create and map custom properties for all other data. SmartPlant Materials can be customized to perform wall thickness calculations. SmartPlant Materials is able to publish the line list documents to SmartPlant Foundation. Pre-configuration of the map schema file and SmartPlant Materials is needed to publish line list documents and control the line list data published to SmartPlant Foundation.

Configure Line List Integration

Page 128: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

128 SmartPlant Materials Adapter and Integration Configuration Guide

Limitations Line List Integration 1. User cannot modify the following map class names while configuring the map schema file for

publish or retrieve of the line list documents. SPMAT_LINE SPMAT_DN SPMAT_PUB_LINE SPMAT_PUB_DN

2. User cannot modify the following property names while configuring the map schema file for publish or retrieve of the line list documents. Fluid_Code From_Location To_Location O_Pressure O_Temperature Pressure Temperature Spec_Header DN WT

3. The corresponding Map Enum or Map UOM values need to be mapped before trying to publish the line list document. These properties are located in the map schema file in the following locations Fluid_Code - Located in the Enumerated List Definition "FLUID_SYSTEM" O_Pressure, Pressure - Located in the UOM List Definition "PRESS_UOM" O_Temperature , Temperature - Located in the UOM List Definition "TEMP_UOM" DN, WT - Located in the UOM List Definition "LENGTH_UOM"

For more information, see Unit of Measure Mapping (on page 133) and Enumerated Lists Mapping (on page 136).

Page 129: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

SmartPlant Materials Adapter and Integration Configuration Guide 129

Line List Mapping Line List Documents Publish Mapping

To control what data from the line list documents to publish from SmartPlant Materials, configure the map schema file with the valid property mappings. Add the properties to publish and remove any properties not to publish from SmartPlant Materials. Two map classes, SPMAT_PUB_DN and SPMAT_PUB_LINE, are used to map the line list record and pipeline properties for publish.

Publish Mapping for Pipeline Property Mapping All mapping that corresponds to the publishable pipeline is mapped under the map class SPMAT_PUB_LINE. By default there will be some hard-coded properties that were mapped for pipeline under the map class SPMAT_PUB_LINE. These properties names should not be changed. The default mapping properties that were delivered along with map schema are shown below.

For Map Class SPMAT_PUB_LINE

The relation between map properties and the corresponding columns in the SmartPlant Materials Pipeline Record is as shown below.

S.No Map Property Name Column in the screen L.20.01 corresponding to the line list record.

1 Fluid_Code Fluid Code

Page 130: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

130 SmartPlant Materials Adapter and Integration Configuration Guide

S.No Map Property Name Column in the screen L.20.01 corresponding to the line list record.

2 From_Location From Location

3 O_Pressure Oper. Pressure

4 O_Temperature Oper. Temper.

5 Pressure Design Pressure

6 Spec_Header Spec Header

7 Temperature Design Temper.

8 To_Location To Location

The map properties with name From_Location and To_Location should be mapped to the corresponding SmartPlant Schema properties.

Publish Mapping for Nominal Diameter Record Property Mapping All mapping corresponds to the publishable line list nominal diameter record is mapped under the map class SPMAT_PUB_DN. By default there will be some hard-coded properties that were mapped for line list nominal diameter record under the map class SPMAT_PUB_DN. These properties names are hard-coded and they should not be changed. The default mapping properties that were delivered along with map schema are shown below.

The relation between map properties and the corresponding columns in the SmartPlant Materials Line List Nominal Diameter Record is as shown below.

Page 131: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

SmartPlant Materials Adapter and Integration Configuration Guide 131

S.No Map Property Name

Column in the screen L.20.01 corresponding to the line list nominal diameter record.

1 DN Diameter

2 WT Wallthickness

Map Additional Properties To include any additional properties on any of the four map classes to retrieve or publish into SmartPlant Materials, add it with the name of the property. New properties are first created as an attribute in screen A.50.01 Attributes in SmartPlant Materials. Any new or existing attribute in SmartPlant Materials is then created as a map property in the appropriate map class. When complete, the additional properties can be published to SmartPlant Foundation.

The following table provides an example of attributes in SmartPlant Materials that can be mapped for retrieve or publish.

Attribute / Property Publish Map Class

PIPINGCONNECTORSEQUENCENO SPMAT_PUB_LINE

SCHEDULETHICKNESS2 SPMAT_PUB_DN The following example explains the steps to create a map property based on the SmartPlant Materials Attribute and map it to the SmartPlant Schema for publish. In this example, we create the property, PIPINGCONNECTORSEQUENCENO, and map it to SPMAT_PUB_LINE. These steps can be repeated to map the properties in the table above.

Page 132: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

132 SmartPlant Materials Adapter and Integration Configuration Guide

1. To create a new map property, right-click MapProperties on the SPMAT__PUB_LINE shortcut menu, then click Create SPMapPropertyDef.

2. In the New Map Property Definition dialog box, enter the name and description of the

additional property.

3. Click OK to create the new property.

Page 133: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

SmartPlant Materials Adapter and Integration Configuration Guide 133

4. Map this additional property to the corresponding SmartPlant Schema property.

If the property does not exist in the SmartPlant Schema, you will have to create it. See

Create a Property Definition in the Schema Editor User's Guide. Repeat the steps above to add other properties under a map class. For example, map UOM and enumerated list definitions to retrieve into SmartPlant Materials the line list record properties of the line list documents from SmartPlant Foundation. For more information, see Unit of Measure Mapping (on page 133) and Enumerated Lists Mapping (on page 136).

Unit of Measure Mapping You can map the Unit of Measures (UOMs) in the map schema. Three UOM definitions are delivered as default with the map schema file. LENGTH_UOM - Applicable for properties that are measured in length format (Nominal

Diameter and Wall thickness). PRESS_UOM - Applicable for properties Operating Pressure and Design Pressure. TEMP_UOM - Applicable for properties Operating Temperature and Design Temperature

Page 134: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

134 SmartPlant Materials Adapter and Integration Configuration Guide

All UOM definitions are mapped at the following location inside Map schema file.

1. To add a new Map Enum to LENGTH_UOM, right-click MapEnum under the

LENGTH_UOM tree, then click Create SPMapUomDef on the shortcut menu.

Page 135: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

SmartPlant Materials Adapter and Integration Configuration Guide 135

2. In the New SPMapUoMDef dialog box, enter the name and description of the MapUOMDefinition.

3. Map the new Map Enum to the corresponding UoM value as shown below.

Page 136: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

136 SmartPlant Materials Adapter and Integration Configuration Guide

4. In A.10.12 Unit of Measure, create a Unit under QUANTITY with the same name as that of the MapEnum value (In the above example, the unit is IN).

For the other two UOM List definitions, the value of the Map Enum should be under Unit Groups in SmartPlant Materials as shown in the following table.

UOM List Definition Unit Group in the screen A.20.12 that should have the Unit with the name of the MapEnum

LENGTH_UOM Quantity

PRESS_UOM Pressure

TEMP_UOM Temperature Mapping can be done before publishing, but you must complete the mapping of unit

properties before you can publish.

Enumerated Lists Mapping You can also map the enumerated list definitions (ENUMs) in the map schema.

Page 137: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

SmartPlant Materials Adapter and Integration Configuration Guide 137

All enumerated list definitions can be added at the following location for the properties that have valid values in the EFSchema.

One Enum List definition is delivered as default with the Map Schema file. FLUID_SYSTEM - Applicable only for Fluid Codes.

1. To add a new Map Enum to FLUID_SYSTEM, right-click MapEnum under the FLUID_SYSTEM tree, then click Create SPMapEnumDef on the shortcut menu.

Page 138: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

138 SmartPlant Materials Adapter and Integration Configuration Guide

2. In the New SPMapEnumDef dialog box, enter the name and description of the MapEnumDefinition.

3. Map the new MapEnum to the corresponding Enum value as shown below.

The fluid code is created as a fluid definition on the screen S.60.02 Fluid Definitions screen in SmartPlant Materials. 1. Type the name of the Fluid Group.

Page 139: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

SmartPlant Materials Adapter and Integration Configuration Guide 139

2. Type the Fluid Code. 3. Type the short description. 4. Type a Status. 5. Repeat steps 1 - 4 to continue creating fluid codes. 6. Click Save.

All enumerations and UOMs can be assigned to the map properties in the following locations.

Mapping can be done before publishing, but you must complete the mapping of unit

properties before you can publish.

Page 140: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

140 SmartPlant Materials Adapter and Integration Configuration Guide

Configure MTI to Publish Line List Documents The following topics explain the setting and mappings that are required to publish the line list documents from SmartPlant Materials to SmartPlant Foundation.

MTI 10.32 SmartPlant Materials Publish Type Mappings 1. On the screen MTI 10.32 SmartPlant Materials Publish Type Mappings screen, scroll to

the SPF Plant. 2. Select Line List Calculation under Publish Type Mappings, and then click Add to

workload to run the PUBLISH_LL command.

MTI-S must be running to process any tasks that are added to the workload.

3. To see the line list documents that were published to SmartPlant Foundation, click the Published Line Lists tab on the MTI 10.35 SmartPlant Materials Published Documents screen. The Status column under Line List Documents defines whether the line list document was successfully published or not. If the status is OK, the line list document successfully published. If the status is ERROR, the line list document did not publish. To see the error that

occurred, review the log tables or the log files created in the MTI installation folders.

Page 141: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

SmartPlant Materials Adapter and Integration Configuration Guide 141

If the status is NEW, the document is not yet processed or retrieved into MTI from SmartPlant Materials.

4. Double-click a Pipe Line or a Line List Record to show any additional properties for the pipe

line or nominal diameter.

Page 142: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Configure Line List Integration

142 SmartPlant Materials Adapter and Integration Configuration Guide

Page 143: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

SmartPlant Materials Adapter and Integration Configuration Guide 143

A Adapter Architecture • 9 Add a Class Definition Mapping to

MARIAN_BOM_NODE • 37 Additional Attributes • 47, 59

B BOM Retrieving Settings • 16

C Change Mapping of BOM_Node_ShortDesc

or BOM_Node_Description • 32 Common Configuration Tasks • 77 Configure BOM Data Retrieval • 104 Configure Document Retrieval • 93 Configure Line List Integration • 127 Configure MTI to Publish Line List

Documents • 140 Configure SmartPlant Materials Publish • 101 Control Processing • 107

D Database Settings • 12 DBA Settings • 23 Document Retrieving Settings • 14

E Enumerated Lists Mapping • 136

F File-Based BOM Retrieve Settings • 23 First Installation • 116

G General Requirements • 115

I Introduction • 7

L Limitations • 128 Line List Documents Publish Mapping • 129 Line List Mapping • 129

M Map Additional Properties • 131 Mapping • 25 Mapping for BOM Retrieve from SmartPlant

3D • 28 Mapping for BOM Retrieve from SmartPlant

Isometrics • 53 MTI 10.01 SmartPlant Parameters • 77 MTI 10.11 SmartPlant Materials Projects • 79 MTI 10.12 SPF Plants and Projects • 84 MTI 10.13 Plant/Project Mappings • 89 MTI 10.21 SPF Document Type Hierarchy •

93 MTI 10.22 Document Type Mappings • 97 MTI 10.25 SmartPlant Enterprise Retrieved

Documents • 100 MTI 10.31 SmartPlant Materials Publish

Types • 101 MTI 10.32 SmartPlant Materials Publish

Type Mappings • 102, 140 MTI 10.41 BOM Doc Type Mappings • 104 MTI 10.45 Retrieved BOM Documents • 106 MTI 90 Information • 107 MTI 90.01 Supported SmartPlant Materials

Versions • 107 MTI 90.11 Workload • 109 MTI 90.21 Logging • 111 MTI-DB • 61 MTI-DB Installation • 61 MTI-DB Migration from 6.3.8 to 7.0.0 • 71 MTI-S • 115 MTI-S Configuration • 123 MTI-S Installation • 116 MTI-UI • 75 MTI-UI Configuration • 77 MTI-UI Installation • 75

Index

Page 144: SmartPlant Materials - WebUtilspmat.hec.co.kr/marian_webentry/PDFs/MTI-Install.pdf · SmartPlant Materials Adapter and Integration Configuration Guide 3 Contents Preface

Index

144 SmartPlant Materials Adapter and Integration Configuration Guide

N Node Attributes • 47

P Plant Breakdown Structure • 10 Plant Breakdown Structure (PBS) Retrieval

Settings • 22 Position Attributes • 49 Preface • 5 Project Defaults • 12, 16, 22, 23 Publish Mapping for Nominal Diameter

Record Property Mapping • 130 Publish Mapping for Pipeline Property

Mapping • 129 Publishing Settings • 13

R Registering SmartPlant Materials with

SmartPlant Plants • 86 Remove a Class Definition from Mapping •

40 Requisitions and Purchase Orders • 15

S SmartPlant Foundation Web Client • 14 SmartPlant Materials Attributes • 17 SmartPlant Materials BOM Nodes • 29, 54 SmartPlant Materials BOM Positions • 40, 56 SmartPlant Materials Configuration • 11 SmartPlant Materials Installation • 11 SmartPlant Materials Projects • 11, 83 SmartPlant Materials Publish-Retrieve

Relationships • 10 SmartPlant Materials Tagged Items • 45 Starting MTI-S • 124

U UID Construction • 10 Unit of Measure Mapping • 133 Upgrading from Previous Versions • 122

W What's New? • 5