SmartPlant Materials Documentation User’s Guidespmat.hec.co.kr/marian_webentry/Pdfs/SPMAT Documentation...input parameters. This feature can help to troubleshoot the upload process

SmartPlant Materials Documentation User’s Guide

Version 2011 R1 SP2 (7.1.2)

November 2014

DMAR1-PE-200150B

Copyright Copyright © 2012-2014 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.

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

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 300 Intergraph Way Huntsville, AL 35813

Documentation Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides, Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a particular software product.

Other Documentation Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support, SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph as guidance for using a software product.

Terms of Use a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the

software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this software product and Documentation. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal, non-commercial use. The Documentation may not be printed for resale or redistribution.

b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid licenseagreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any reason by Intergraph Corporation by giving written notice to Licensee.

Disclaimer of Warranties Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its publication date.

The information and the software discussed in this document are subject to change without notice and are subject to applicable technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.

The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.

Intergraph 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.

2 SmartPlant Materials Documentation User’s Guide

Limitation of Damages IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL, SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2) YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.

IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.

Export Controls Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access) under the following circumstances:

a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries. b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce

Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S. Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S. Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.

c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design, development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive nuclear uses.

d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place. e. Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export

Compliance Department, Huntsville, Alabama 35894, USA.

Trademarks Intergraph, the Intergraph logo, Intergraph Smart, PDS, SmartPlant, SmartMarine, FrameWorks, I-Sketch, IntelliShip, ISOGEN, SmartSketch, SPOOLGEN, SupportManager, SupportModeler, Sapphire, and FreeView 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.

SmartPlant Materials Documentation User’s Guide 3


Contents Preface .......................................................................................................................................................... 7

Documentation Comments ..................................................................................................................... 7

Setup ............................................................................................................................................................. 9

DBA Settings ........................................................................................................................................... 9 Project Defaults ....................................................................................................................................... 9

Documents ................................................................................................................................................. 11

Load Documents ................................................................................................................................... 11 Maintain Documents ............................................................................................................................. 12 Document Sets...................................................................................................................................... 18

Text and Terms .......................................................................................................................................... 21

Maintain Text and Terms ...................................................................................................................... 21 Maintain Text and Term Sets ................................................................................................................ 23 Copy Text and Terms ........................................................................................................................... 24 Copy Text and Term Sets ..................................................................................................................... 25

Notes ........................................................................................................................................................... 27

Maintain Notes ...................................................................................................................................... 27 Copy Notes ........................................................................................................................................... 29

Vendor Data Requirements ...................................................................................................................... 31

Configure VDR Events .......................................................................................................................... 31 Maintain Vendor Data Requirements .................................................................................................... 32 VDR Sets .............................................................................................................................................. 34

Templates ................................................................................................................................................... 37

SOW Templates .................................................................................................................................... 37 Copy SOW Templates .......................................................................................................................... 39

Index ........................................................................................................................................................... 41


Contents


This document describes the Documentation module in SmartPlant Materials.

Documentation Comments Send documentation comments or suggestions to [email protected] (mailto:[email protected]?subject=documentation comments).

Preface


mailto:[email protected]?subject=documentation%20comments

Preface


S E C T I O N 1

When you start a new project in SmartPlant Materials, you must set up several project defaults and DBA settings for the Documentation module.

DBA Settings If you import documents into the software, the following DBA settings must be defined:

DOC_IMPORT_PATH - You must define the UTL_FILE_DIR directory of the database as the default directory for the document import.

DOC_TIMEOUT – With this setting, you define the time after which the software stops trying to upload a file.

DOC_UPLOAD_CMD_ARGV_TRACE – This DBA setting controls the extended tracing for input parameters. This feature can help to troubleshoot the upload process. If you set this parameter to Y, the additional trace file doc_upload_trace.log is created in the directory specified by the DBA setting DOC_UPLOAD_DEST on the application server. This log file will have the text of the called program with all input parameters.

DOC_UPLOAD_DEST - Destination for upload of document files in the web environment. This DBA setting defines the name of the directory into which an uploaded document or uploaded document import file is to be written on the application server.

DOC_UPLOAD_URL - Virtual directory for uploaded document files in the web environment. This DBA setting defines the virtual directory for an uploaded document import file; it must point to the same directory as DOC_UPLOAD_DEST.

SERVLET_PATH - Path in the file system of the application server for servlets, including the name of the application server.

RBS_DOC – Assign a particular rollback segment for the document import job.

For more information about DBA settings, see the SmartPlant Materials DBA Settings guide, available from the Printable Guides page in the software.

Project Defaults The project defaults that are relevant to the Documentation module are listed below.

ZI_DOC_IN - DB server path for the documentation import. This project default corresponds with the DBA setting DOC_IMPORT_PATH.

ZI_WEB_DOC - Virtual directory for documents in the web environment.

ZI_WEB_TT - Virtual directory for text and terms in the web environment.

ZX_DOC_CIP - With this project default, you can control whether the standard procedure or a CIP procedure is used when you click Upload or Open. By default, the standard code is used. If you want to use the CIP functionality, you must set the project default to Y and

Setup


Setup

modify the CIP procedures upload_document and open_document in the mar_custom library. When the CIP feature is activated, the table m_used_files is used to temporarily store the file to be uploaded. The CIP then loads the file to a directory, a share, or other applicable location. The STATUS_CODE field is available on table m_used_files to store the success or the failure of the upload. It is a numeric field. If it contains the value 0, the upload operation was successful, and the Source Path and File Name fields are set. If any value other than 0 is returned, these fields are not filled. Regardless of whether the upload was successful or not, the message that is returned by the CIP appears. After a successful upload of the file, the record in m_used_files can be deleted; the standard procedure does not need this record to work properly. When working with the CIP feature and the open_document procedure, a message only appears if the CIP returns a value.

ZX_DOC_CLS - If this project default is set to Y, the document code is generated automatically based on the document class.

ZX_DOC_SET - Default document set used by the supplier login, where it will be queried automatically when D.10.12 is called.

ZX_DO_ORD - Select N for numbers or L for letters as the document revision order on D.10.11 and D.90.21 (Documents tab).

ZX_PROJ_PG – If this project default is set to Y, data from the project and product group is displayed on D.30.11. If it is set to N, only data from the project is displayed.

For more information, read the SmartPlant Materials Project Defaults guide, available from the Printable Guides page in the software.


S E C T I O N 2

To open the screens of the Documents branch, select Others > Documentation > D.10 Documents from the menu tree.

Load Documents The document import interface is a tool for importing documents into SmartPlant Materials quickly and easily. On the D.10.01 Load Documents screen, you can define and run document import jobs.

For the required settings, refer to DBA Settings (on page 9) and Project Defaults (on page 9).

Documents


Documents Check the result of the import on the D.10.11 Documents screen.

For more information, read the SmartPlant Materials Document Import Interface (DII) guide, available from the Printable Guides page in the software.

Maintain Documents Documents that can be used as attachments for requisitions, inquiries, or agreements are usually defined, stored, and maintained in a document management system. SmartPlant Materials contains a list of documents, which can be grouped into a set of documents. Documents can either be stored manually on the D.10.11 Documents screen or by data load from an ASCII file on the D.10.01 Load Documents screen.

You must have the MODIFY LOADED DOCUMENTS privilege to modify documents that

were loaded from an ASCII file. For more information about privileges, see User Privileges in the SmartPlant Materials Administrator's Guide, available from the Printable Guides page in the software.

Only documents that have been stored manually can be modified.

If a document has been attached to a requisition, inquiry, or order, you are not able to delete it. As soon as the requisition, inquiry, or order has been approved, you cannot modify the document any longer if project default ZX_CD_CO is set to N.

This screen is a core workflow screen. For more information, see the Core Workflow Screens chapter in the SmartPlant Materials User Interface Basics document, available from the Printable Guides page in the software.


Documents By default, the data on this screen is displayed ordered by document code and revision. The display order is shown in the Ordered by field on top of the screen. To change the order criteria, you can click Order By ... at the bottom of the screen. Or, you can open the pop-up menu with a right mouse-click in any field, and select the 'Order by this field ascending' or the 'Order by this field descending' menu items.

The Document Code field displays the name of the document.

The Manual indicator shows whether this document has been inserted manually or via data load from an ASCII file.

The SmartPlant indicator shows if this document has been retrieved from SmartPlant Integration.

The Rev field displays the revision number of the document. The default revision depends on the setting of project default ZX_DO_ORD. If ZX_DO_ORD it set to N (Numbers), the default revision is 0 (zero). If ZX_DO_ORD is set to L (Letters), the default revision is A.

Revision numbers can only be updated if project default ZX_UPD_RE is set to Y.

To create a new document revision, click Revision.

Numeric revisions are regarded as being newer/higher than alphanumeric revisions. For example, in the design phase of the project, alphanumeric revisions (A, B, C, ...) are used, and in the construction phase numeric revisions (0, 1, 2, ...) are used.

The Version field displays the document version coming from SmartPlant. This field is read-only.

The SmartPlant Rev field shows the revision of this document in the SmartPlant Foundation environment. This revision may be different from the revision of the document in SmartPlant Materials because in SmartPlant Materials the revision of a document must be unique. When you retrieve a document with the same SmartPlant revision but a different version, the software increases the SmartPlant Materials revision by one.

The SmartPlant Version UID field shows the SmartPlant Foundation UID of the particular version of this document.

The document descriptions are displayed in the Short Desc and Description fields.

The Category field shows the SmartPlant document category. A category contains document types.

The type of the document is displayed in the Type field. For documents coming from SmartPlant, the document type belongs to a document category and may contain document subtypes. The subtype is displayed in the Subtype field. A subtype belongs to a document type.

The Title field shows the document title coming from SmartPlant. This field is optional and must not be filled.

The UID field displays the unique identifier of this document in the SmartPlant environment. This field is mandatory for documents coming from SmartPlant.

The Org. Document Code field displays the original document name coming from SmartPlant. This column is filled with the document name only if a conflict of duplicate document names occurs. To guarantee uniqueness within the software, the column docu_code is filled with a concatenation of the ID and a substring of the document code.

The SmartPlant Plant field shows the original SmartPlant plant that the document has been retrieved from. The SmartPlant Project field shows the original SmartPlant project that the document has been retrieved from.


Documents You can enter the number of pages in the document in the No. Pages field.

The Document Date field displays the date when the document was created.

The Changed Date field displays the date of the last document change.

In the Comment field, you can enter any comment about the document, with a maximum length of 240 characters.

In the Client Ref. field, you can enter the client reference, that is, the name of the document that the client is using.

In the Partner Ref. field, you can enter the partner reference, that is, the name of the document that a partner is using.

The List of Units field displays a list of units concerning this document.

The project discipline in which the document has been created is displayed in the Discipline field.

You can enter the main material code in the Material Code field.

The List of Tags field shows the list of tag numbers related to this document.

In the Origin field, you can select a pre-defined origin from the LOV. An origin represents the office that is responsible for the information. You can double-click in this field to open the A.10.33 Origins screen where origins are defined.

Select a path type from the drop-down list in the Path Type field. The available values are

Physical

Link

DB Storage

If you select the ‘Physical’ path type, the file name of the document is added to the value of project default ZI_WEB_DOC when you open the document using Open.

If the path type is 'Link,' the browser opens using the values in the Source Path and File Name fields when you click Open.

If the path type is 'DB Storage,' the document is stored in the database and is retrieved correspondingly.

The Source Path field displays the path of the file containing the document. This field is not available for path type 'DB Storage'.

The File Name field displays the file name of the document.

In the Format field, you can enter the format of the document.

The Author field can be used to enter the author of the document.

In the Changed By field, enter the person by whom the document was changed the last time.

In the Authorized By field, enter the person by whom the document has been authorized. Select the date of authorization from the LOV in the Authorization Date field.

In the Status field, you can enter the document status.

You can select the name of a parent document from the LOV in the Parent Document Code field. The Parent Rev field is automatically populated with the revision of the parent document.

In the Reference field, you can enter a library reference for the document.


Documents The Directa Class field displays the document class in Directa, the Directa Type field shows the type of the Directa document, and the In Directa indicator shows whether the document is known by Directa or not. These Directa-related fields are not used or supported any longer.

You can click Order By ... button to change the order criteria or you can open the pop-up menu with a right mouse-click in any field, and select the 'Order by this field ascending' or the 'Order by this field descending' menu items.

You can use the Upload button to upload a file into the database or to any server or share within the network. If the path type is set to 'DB Storage,' the file is uploaded into the database. In all other cases, the file is uploaded to the selected server or share, and the path type is automatically set to 'Link.' Regardless of the path type, you first select the file that you want to upload from a file selection dialog box.

Select the file and click Open. If the file is to be uploaded to a server or share, you must select the destination from another dialog box that opens.

These destinations are set up on the A.10.38 File Destinations screen. For more information, see File Destinations in the SmartPlant Materials Administrator’s Guide, available from the Printable Guides page in the software.


Documents If the selection of subdirectories is allowed for a destination (Sub Dir check box selected on A.10.38), a directory selection dialog box appears.

You can only select any subdirectory of the given destination path. An error message appears if you move up in the directory hierarchy or select a completely different drive or directory.

If subdirectories are available but you do not want to select any subdirectory, just click Cancel. This action uploads the file to the directory that was originally selected.

If you want to select a subdirectory, just click once on the name of that subdirectory. This subdirectory name is copied to the File Name field. Click OK to continue.

If you want to select a sub-subdirectory, double-click on the (first) subdirectory. This action gives you a list of the subdirectories below that directory. Then, click once on that subdirectory to select it, and then click OK.

With double-clicks, you can move down in the hierarchy, and with (single) clicks you select directories. Using the Cancel button, you can select the current directory if you have moved down too far or do not want to move down at all.

To upload the file to its final destination, DBA setting DOC_UPLOAD_DEST must be set because the file is saved intermediately on the application server. See DBA Settings (on page 9) for the details.

If the file is uploaded successfully, the Source Path and File Name fields are automatically populated with the appropriate values so that you can open the file using the Open button.

If you want to use your own code for uploading a file, you must set the project default ZX_DOC_CIP to Y and modify the library mar_custom. See Project Defaults (on page 9) for the details.


Documents To link a file with the selected document, click Link. A box opens where you can select a pre-defined server path or share.

These destinations are set up on the A.10.38 File Destinations screen. For more information, see File Destinations in the SmartPlant Materials Administrator’s Guide, available from the Printable Guides page in the software.

Select the destination and click OK to continue. A file selection box opens where you can select the file to be linked.

Select the file and click Open to continue. The Source Path and File Name fields on D.10.11 are automatically populated with the appropriate values and the path type is set to ‘Link'.

You can click Open to open the file entered in the File Name field. If the document has been retrieved from SmartPlant, the document is opened within SmartPlant Foundation Desktop Client and SmartPlant Markup. It is necessary to have the software installed to make use of this functionality. If the document has not been retrieved from SmartPlant and the path type is set to 'Physical', the project default ZI_WEB_DOC must be set. Otherwise, the software is not able to find the file. For the other path types, no additional settings with respect to project defaults or DBA settings are required. If you want to use your own code for opening a file, you must set the project default ZX_DOC_CIP to Y and customize the library mar_custom. See Project Defaults (on page 9) for the details.


Documents Click Revision to create a new revision of the selected document. A box opens where you can enter the new revision number.

Click Create Revision to continue.

This button is not available for documents that have been retrieved from SmartPlant Integration.

Document Sets Documents can be grouped into a set of documents. Such a set can be used for assigning more than one document in one step to objects such as engineering requisitions, inquiries, or purchase orders using the D.90.21 Attachments screen. For more information, see Attachments in the SmartPlant Materials User Interface Basics guide, available from the Printable Guides page in the software.

Document sets can be created with different revisions. When a new revision is created, the current revision is copied including its language dependent descriptions and its details. Only the actual revision of a set can be modified.


Documents Document sets are maintained on the D.10.12 Document Sets screen.

In the first (Document Sets) block, you define the document sets.

Enter the name of the document set in the Document Set field, the revision number of the set in the Rev field, and the set descriptions in the Short Desc and Description fields.

To create a new revision of a document set, click Revision. The software creates the new revision of the set with all its details. Creating a new revision also means that all older revisions cannot be changed any longer. This button is only enabled for the highest revision of a document set.

When you click Open, the document selected in the second block opens if a file name has been entered in the File Name field. If the document has been retrieved from SmartPlant, the document is opened within SmartPlant Foundation Desktop Client and SmartPlant Markup. It is necessary to have the software installed to make use of this functionality. If the document has not been retrieved from SmartPlant and the path type is set to 'Physical,' the project default ZI_WEB_DOC must be set. Otherwise, the software is not able to find the file. For the other path types, no additional settings with respect to project defaults or DBA settings are required. If you want to use your own code for opening a file, you must set the project default ZX_DOC_CIP to Y and customize the library mar_custom. See Project Defaults (on page 9) for the details.

In the second (Document Set Details) block, you assign documents to the selected document set.

Only one revision of a document can be assigned to a document set.

The Seq field displays the sequence number. This sequence number is used to order the documents within the set.


Documents The Document Code field shows the name of the document, with the document revision in the Revision field. See Maintain Documents (on page 12) for the description of the other fields.

To assign a document to the set, use the LOV in the Document Code field. A window opens where you can select multiple documents to be assigned.

Select the Sel check box of all documents that you want to assign. Or, click Select All to select all displayed documents. Clicking Unselect All cancels the current selection. Finally, click Fill In to assign the selected documents to the document set.

You can click the Display Only Highest Revision check box at the bottom of the screen to limit the displayed documents. Then only the highest revision of the documents is displayed.


S E C T I O N 3

To open the screens of the Text and Terms branch, select Others > Documentation > D.20 Text and Terms from the menu tree.

Maintain Text and Terms Text and terms can be attached to different business objects such as requisitions, inquiries, and orders. When attaching text and terms to a requisition template, the text and terms are copied to each engineering requisition created by the MTO.

Text and Terms


Text and Terms Text and terms are maintained on the D.20.11 Text and Terms screen.

Select the type of the text and term from the drop-down list in the Term Type field. The available types are:

Engineering Requisition – Text and terms of this type can be assigned to requisition templates and to requisitions.

Inquiry – Text and terms of this type can be assigned to objects within the inquiry cycle. That is, they can be assigned to inquiries and quote summaries.

Purchase Order – Text and terms of this type can be assigned to any agreement (purchase order, notice of commitment, or change or blanket order).

Enter the name of the text and term in the Term Code field, the text and term revision in the Rev field, and the text and term descriptions in the Short Desc and Description fields.

The Usage Parameter field indicates the way the terms are used.

The File Name field displays the file name of the text and terms file on the operating system.

You can click Revision to create a new revision of the selected text and term.

You can click Open to open the selected text and term file if a file name has been entered in the File Name field. The project default ZI_WEB_TT must be set. Otherwise, the software will not be able to find the file. For the details, see Project Defaults (on page 9).


Text and Terms

Maintain Text and Term Sets Several text and terms can be grouped into a set of text and terms (TT set). Such a set can be used for assigning multiple text and terms in one step to objects such as engineering requisitions, inquiries, or purchase orders using the D.90.21 Attachments screen. For more information, see Attachments in the SmartPlant Materials User Interface Basics guide, available from the Printable Guides page in the software.

Standard text and term sets can be defined at the product group level, copied to the project, and then modified to meet project requirements.

Text and term sets are maintained on the D.20.12 Text and Term Sets screen.

In the first (Sets of Text and Terms) block, you define the text and term sets. Select the text and term type from the drop-down list in the Term Type field. The available types are:

Engineering Requisition

Inquiry

Purchase Order

Enter the name of the text and term set in the Term Set field, the text and term set revision in the Rev field, and the text and term set descriptions in the Short Desc and Description fields.

You can click Revision to create a new revision of the selected text and term set.

In the second (Term Set Details) block, you can assign text and terms to a text and terms set.

When you assign a text to a term set, you must determine whether this text is to be placed in the header or in the footer when it is attached, for example, to a requisition. Select Header or Footer from the drop-down list in the Placement field.

With the sequence number in the Seq field, you define in which order the text and terms are displayed in the header or the footer.

See Maintain Text and Terms (on page 21) for the description of the other fields.


Text and Terms

Copy Text and Terms You can use the D.20.05 Copy Text and Terms screen to copy text and terms from the current product group into the current project.

Only text and terms that are specified in the product group and that do not exist in the login project are displayed.

The Term Type field shows the type of the text and term.

The name of the text and term is displayed in the Term Code field, the text and term revision in the Rev field, and the text and term descriptions in the Short Desc and Description fields.

The Usage Parameter field indicates the way the terms are used.

The File Name field displays the file name of the text and terms file on the operating system.

Select the Copy check box of all text and terms you want to copy. Then, click Copy Text and Terms to copy the selected text and terms from the product group to the login project.

After the copy operation is complete the copied text and terms are not displayed any longer.


Text and Terms

Copy Text and Term Sets You can use the D.20.06 Copy Text and Term Sets screen to copy text and term sets from the current product group into the current project.

In the first (Sets of Text and Terms) block, the text and term sets that are specified in the product group and that do not exist in the login project are displayed.

The Term Type field shows the type of the text and term set.

The name of the text and term set is displayed in the Term Set field, the text and term set revision in the Rev field, and the text and term set descriptions in the Short Desc and Description fields.

Click Copy Text and Terms Sets to copy the selected set from the product group to the login project.

After the copy operation is complete the copied text and terms sets are not displayed any longer.

In the second (Term Set Details) block, the text and terms that are assigned to the selected set are displayed. See Maintain Text and Term Sets (on page 23) for the field descriptions.


Text and Terms


S E C T I O N 4

To open the screens of the Notes branch, select Others > Documentation > D.30 Notes from the menu tree.

Maintain Notes Use the D.30.11 Notes screen to define and store notes and comments within your project and discipline for later attachment to requisitions or requisition line items, inquiries, quote summaries, and agreements. First, you must define note types for your notes and comments, and then define the notes within these note types.

Notes


Notes With the project default ZX_PROJ_PG, you can control which data you want to see. If this project default is set to Y, all note types and notes of the product group and the project are displayed. If the project default is set to N, only note types and notes of the login project are displayed. If any note of the product group has been attached to a requisition or a requisition line item, you cannot change the project default anymore.

In the first (Note Types) block, you can define note types.

Select the type of the notes from the drop-down list in the Term Type field. The available values are:

Engineering Requisition

Inquiry

Purchase Order

Enter the name of the note type in the Note Type Code field.

The note type revision is automatically set to 0 (zero) and displayed in the Rev field.

Enter the note type descriptions in the Short Desc and Description fields.

The project or product group where the note type was created is displayed in the Project field.

To create a revision of the note type, click Type Revision. A new note type revision is created, and all notes of the previous revision are copied to this new revision.

In the second (Notes) block, you can define notes for the selected note type.

Enter the note name in the Note Code field. The note revision is automatically set to 0 (zero) and displayed in the Rev field. Enter the note descriptions in the Short Desc and Description fields.


Notes The Attached to Req? value indicates whether the note is already attached to a requisition, and if the requisition is approved in case the note is attached. The available values are:

Approved: The note is attached to one or more approved requisition(s).

Not approved: The note is attached to one or more requisition(s) that are not approved.

Unused: The note is not attached to any requisition.

To create a new revision of the selected note, click Note Revision.

Copy Notes You can use the D.30.05 Copy Notes screen to copy notes from the current product group into the current project.

In the first (Note Types) block, the note types are displayed.

The Term Type field shows the type of the notes.

The name of the note type is displayed in the Note Type Code field, the note type revision in the Rev field, and the note type descriptions in the Short Desc and Description fields.

In the second (Copy Notes) block, the notes that are assigned to the selected note type, that are specified in the product group, and that do not exist in the login project are displayed.

The name of the note is shown in the Note Code field, the revision of the note in the Rev field, and the note descriptions in the Short Desc and Description fields.

The Attached to Req? value indicates whether the note is already attached to a requisition, and if the requisition is approved in case the note is attached. The available values are:


Notes Approved: The note is attached to one or more approved requisition(s).

Not approved: The note is attached to one or more requisition(s) that are not approved.

Unused: The note is not attached to any requisition.

Select the Copy check box of all notes you want to copy. Then, click Copy Notes to copy the selected notes from the product group to the login project.

After the copy operation is complete the copied notes are not displayed any longer.


S E C T I O N 5

To open the screens of the Vendor Data Requirements branch, select Others > Documentation > D.40 Vendor Data Requirements from the menu tree.

Configure VDR Events Use the D.40.01 Events screen to define events for vendor data requirements (VDRs).

The following screens offer LOVs to select events from D.40.01 Events:

D.40.11 Vendor Data Requirements

D.40.12 VDR Sets

D.90.21 Attachments

Vendor Data Requirements


Vendor Data Requirements P.70.81 VDR Submittal and Status

To define an event, type the event name in the Event box, and the event descriptions in the Short Desc and Description boxes. One event must be defined as the default using the Default check box.

Maintain Vendor Data Requirements Use the D.40.11 Vendor Data Requirements screen to define and maintain vendor data requirements (VDRs).

A VDR defines which documentation is required from the vendor for delivery. It describes the types of drawings and the needed data.

VDRs can be created with different revisions. When a new revision is created, the current revision is copied, including its language dependent descriptions. Only the highest revision of a VDR can be modified.

Enter the name of the vendor data requirement (VDR) in the VDR field. The VDR revision is displayed in the Rev field. When you create a new VDR, the revision is automatically set to 0 (zero). Enter the VDR descriptions in the Short Desc and Description fields. You must scroll to the right to see these fields.

Select the pre-defined distribution category from the LOV in the Distribution Category field. Distribution categories are defined on the A.10.52 Distribution Categories screen. Select the Required indicator to mark this VDR as required for document management.

To pre-define a default traffic document, select the Traffic VDR check box. Select Supplier or Freight Forwarder from the Expected From drop-down list to specify, who is expected to


Vendor Data Requirements deliver the document. With the VDR Type you define, to which packing lists (PLs)/preliminary packing lists (PPLs) the document should be assigned. Select HLO only if the document should be assigned only to PLs/PPLs that contain at least one heavy load object (HLO) package item. Select Hazardous only if the document should be assigned only to PLs/PPLs that contain at least one hazardous package item. The empty (default) value indicates, that the document will be assigned to all PLs/PPLs. If the document is expected from the supplier, the traffic coordinator has to decide, if the freight forwarder should have access to the uploaded document. In that case, select the FF Access check box to allow the freight forwarder to view supplier's document.

In the First Issue Copies field, enter the number of copies to be delivered from the supplier. In the Scheduled field, enter the number of days, weeks, or months in which the documents are needed. Select DAYS, WEEKS, or MONTHS from the drop-down list in the Period field to define the period for the value in the Scheduled field.

From the drop-down list in the Event field, select the event when the required documents must be delivered. The available values are:

After order

Before delivery

For construction

With delivery

After erection

Date of order

Date of approval

Date of dispatch

Date of mechanical completion

Select the purpose of the documents from the drop-down list in the Purpose field. Available values are:

Issued for Review

For information

In the Final Issue Copies field, enter the number of copies to be delivered with the final issue from the supplier.

Fill the With Tender Period, With Tender Event, For Approval Period, For Approval Event, For Approval Schedule, Final Period, Final Event, Final Schedule, As Built Period, As Built Event, and As Built Schedule fields with appropriate values.

You can click Revision to create a revision of the VDR. This action locks the previous revision of the VDR.

This button is only enabled for the highest revision of a VDR.


Vendor Data Requirements

VDR Sets Instead of attaching single VDRs, you can attach pre-defined VDR sets. This method groups VDRs into standard sets. The sets are grouped according to the project requirements. The picture below shows an example of a VDR set for pumps.

The standard documents can be included in one set as a single item in the requisition.

To define VDR sets, open the D.40.12 VDR Sets screen from the menu tree, or double-click in the VDR Set field on the VDRs tab of the D.90.21 screen to open D.40.12.

This screen is a core workflow screen. For more information, see Core Workflow Screens in the SmartPlant Materials User Interface Basics document, available from the Printable Guides page in the software.

In the first (VDR Sets) block, you can create and maintain VDR sets.

Enter the name of the VDR set in the VDR Set field and the set descriptions in the Short Desc and Description fields. The revision of a new set is set to 0 (zero) and displayed in the Rev field. To create a new revision of the selected set, click Revision.

To define a traffic VDR set, select the Traffic VDR check box. The traffic VDR set is automatically assigned to a packing list (PL) or preliminary packing list (PPL) when creating the list.

Only one set can be defined as traffic VDR set in a project.

You can click Copy to copy VDR sets from other projects.


Vendor Data Requirements Select a project from the LOV in the Source Project field, and click Continue. A window opens where you can select the VDR sets to copy to the login project.

Select the Sel check box of all VDR sets you want to copy. Or, click Select All to select all displayed VDR sets. Clicking Deselect All cancels the current selection. Click Copy to copy the selected VDR sets from the source project to the login project. Or, click Cancel to close the window without copying any VDR sets.


Vendor Data Requirements In the second (VDR Set Details) block of D.40.12, select the VDRs to be included in the set from the multi-selection LOV in the VDR field.

This screen is a core workflow screen. For more information, see Core Workflow Screens in the SmartPlant Materials User Interface Basics document, available from the Printable Guides page in the software.

All available VDRs are displayed. See Maintain Vendor Data Requirements (on page 32) for the field descriptions.

For traffic VDR sets, only traffic VDRs are available for selection.

Select the Sel check box of all VDRs that you want to attach to the selected VDR set. Or, click Select All to select all displayed VDRs. Clicking Deselect All cancels the current selection. Finally, click Fill In to attach all selected VDRs to the VDR set.

The window is closed, and the copied VDRs are displayed in the second block of D.40.12. Here you can modify the attached VDRs. See Maintain Vendor Data Requirements (on page 32) for the field descriptions. In the VDR Comment field, you can enter a comment about the VDR.


S E C T I O N 6

To open the screens of the Templates branch, select Others > Documentation > D.60 Templates from the menu tree.

SOW Templates The pre-defined SOW (Scope of Work) templates or subcontract templates are used to standardize the work specifications needed for subcontracting. At the beginning of a subcontracting project, you can create company standard SOW templates. For example, you can create a master template in a product group, and then copy that template to different projects. You can then modify the templates at the project level, if needed.

Templates


Templates SOW templates are maintained on the D.60.01 SOW Templates screen.

In the first (SOW Templates) block, enter the name of the SOW template in the SOW Template field and the template descriptions in the Short Desc and Description fields. The template revision is automatically set to the default 0 (zero) and displayed in the Rev field. The system date is entered as the revision date in the Rev Date field.

You can click Revision to create a new revision of the selected SOW template. The revision is increased by 1, and all dependent details (SOW sections) are copied as well. You can update records of the latest revision only. The previous revision of the template is locked; that is, the previous template revision cannot be modified any longer.

In the second (SOW Sections) block, you can describe the single scope of work sections of the selected SOW template. Enter the section name in the SOW Section field, and enter the section descriptions in the Short Desc and Description fields. In the Description field, you can enter up to 20,000 characters, which allows a detailed description of the required work.


Templates

Copy SOW Templates On the D.60.02 Copy SOW Templates screen, you can copy standard SOW templates defined in the product group to your project. Only SOW templates that are available to copy and have not been defined in the current project are displayed.

In the first (SOW Templates) block, you can see all SOW templates from the product group that you can copy to the login project. The product group where the SOW template was defined is displayed in the Product Group field. The template name is shown in the SOW Template field, the template revision in the Rev field, the template descriptions in the Short Desc and Description fields, and the revision date of the template in the Rev Date field.

The template details are displayed in the second (SOW Sections) block. The section name is shown in the SOW Section field, and the section descriptions are shown in the Short Desc and Description fields.

Select the SOW template that you want to copy, and click Copy SOW Template at the bottom of the screen to copy the template to the login project.


Templates


C Configure VDR Events • 31 Copy Notes • 29 Copy SOW Templates • 39 Copy Text and Term Sets • 25 Copy Text and Terms • 24

D DBA Settings • 9 Document Sets • 18 Documents • 11

L Load Documents • 11

M Maintain Documents • 12 Maintain Notes • 27 Maintain Text and Term Sets • 23 Maintain Text and Terms • 21 Maintain Vendor Data Requirements • 32

N Notes • 27

P Preface • 7 Project Defaults • 9

S Setup • 9 SOW Templates • 37

T Templates • 37 Text and Terms • 21

V VDR Sets • 34 Vendor Data Requirements • 31

Index
