smartplant materials and smartplant reference data license...

SmartPlant Materials and SmartPlant Reference Data License Handling

Version 2011 R1 (7.1.0)

November 2013

DMAR1-PE-200049E

Copyright Copyright © 2004-2013 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 and SmartPlant Reference Data License Handling

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

SmartPlant Materials and SmartPlant Reference Data License Handling 3

Contents Introduction .................................................................................................................................................. 7

Documentation Comments ..................................................................................................................... 7 Modules Requiring Licenses ................................................................................................................... 7 SmartPlant Materials Database Configuration and License Counts ....................................................... 7

Integration with Logon Screen .......................................................................................................... 8 Visibility on the A.60.81, A.60.82, and A.30.04 Screens .................................................................. 8 Flexibility of Expiration Dates ........................................................................................................... 9 Synchronization of Licenses ............................................................................................................. 9

License Text Format .................................................................................................................................. 11

Requesting and Installing New Licenses ................................................................................................ 13

Request a License for a New SmartPlant Materials Environment ........................................................ 13 Install a License .................................................................................................................................... 15 Enter Confirmation Code ...................................................................................................................... 16

Renewing Your SmartPlant Materials Production License ................................................................... 19

License Handling with SmartPlant License Manager ............................................................................ 21

Architecture ........................................................................................................................................... 21 Prerequisites ......................................................................................................................................... 22 Installation ............................................................................................................................................. 22 Process ................................................................................................................................................. 26 User Interface ........................................................................................................................................ 26 FAQ ....................................................................................................................................................... 31 Troubleshooting .................................................................................................................................... 31

Index ........................................................................................................................................................... 33


Contents


S E C T I O N 1

This document explains SmartPlant® Materials licensing.

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

Modules Requiring Licenses New customers use SmartPlant Reference Data and SmartPlant Materials instead of the

license modules listed below. So, their license text will contain SmartPlant Reference Data, or SmartPlant Reference Data and SmartPlant Materials, depending on what they have licensed.

The license modules for SmartPlant Materials are:

ADM - Administration

Batch - Batch

BIR - SmartPlant Materials Business Intelligence Reporting

E&PI - Engineering and Procurement Integration

Integrator - Integrator

MLCL - Material Lifecycle Library

MSCM - Material Supply Chain Management

MSCM-SUPP - Supplier Remote Access (E-Supplier)

Site - Site

SmartPlant Materials supports a license-module-user-count model.

SmartPlant Materials Database Configuration and License Counts

Run SmartPlant Materials in its own database. If a SmartPlant Materials database is shared with another application, the connections of the other application could get counted in the SmartPlant Materials license count.

Introduction


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

Introduction

Integration with Logon Screen Entering license information is integrated with the SmartPlant Materials logon screen, where users are now prompted for the license number if it is not present or expired. System administrators or super users can issue licenses to other users.

Visibility on the A.60.81, A.60.82, and A.30.04 Screens License information is available on three screens (A.60.81, A.60.82, A.30.04) to make it more visible to users.

The A.60.81 License screen contains the license information and anyone with access to this screen can view it. Users with more than read-only privileges can change license information on this screen.

The A.60.82 Database Sessions screen displays every SmartPlant Materials session connected to the database. System administrators can see the screen and client where each user is working.

The A.30.04 License Modules/Menus screen displays the following information for each licensed module: screen numbers and names, license expiration date, maximum number of licensed users, number of concurrent users, and SPLM (SmartPlant License Manager) tag.

The available modules with their associated tags are listed below.


Introduction SmartPlant Materials Module SmartPlant License Manager Tag

SPMAT MAT

E&PI MEP

Integrator MIM

MLCL MLC

MSCM MSC

SITE MSM

MSCM-SUPP MSU

SPRD RD

The second (Application Menus) block displays the assigned menu items for the selected license module.

The third (Project Licenses) block can be used to specify the maximum number of licenses that a project can use for the selected license module. Select the project from the LOV in the Project field, and enter the maximum number of licenses in the Max. Licenses Allowed field.

Whenever a screen is opened, the software checks the number of project users accessing the license module to which the screen belongs. If the check is violated, the screen is closed after showing a message.

Flexibility of Expiration Dates Licenses are more flexible at the module level because each module has its own expiration date. System administrators can install and terminate the licenses by module for finer control. The A.30.04 screen displays each module and the license expiration date.

Synchronization of Licenses Licenses are synchronized because each installation requires the customer to return an email containing installation feedback information. Intergraph can compare the licenses they have transmitted to customers and which licenses were actually installed.


Introduction


S E C T I O N 2

License information is readable text, not code, though there is some cryptic key information at the end of the license text. The license information consists of following parts, shown with example values:

LICENSE <SmartPlant Materials>;

The name of the licensed product.

START_VERSION <6.0.0.0>;

The license is valid beginning with the initial release of 6.

END_VERSION <7.X.X.X>;

The license is valid until SmartPlant Materials Version 7. Each intermediate version (as 6.1, 6.4.3, or others) is covered.

START_DATE <11-NOV-2003>;

The license is valid beginning with the named date.

END_DATE <19-SEP-2005>;

The license expires on the named date.

CUSTOMER_NO <14000>;

This number is the customer number Intergraph assigned to you. The customer numbers are the same as the ones used in previous SmartPlant Materials releases.

SERIAL_NO <129EF1458E78890014E>;

The serial number uniquely identifies the actual license text information. Have this number ready when you contact Intergraph about your license.

DATABASE <MAR62>;

The name you assigned to your Oracle database.

DBID <115145705>;

Oracle generates the database ID (DBID) number during Oracle database creation.

SID <mar62>;

The site ID (SID) is the instance name you assigned to your Oracle instance.

MACHINE <DOR-APPDEV02>;

License Text Format


License Text Format The machine name is the host name where your database is located.

MACID <24-57-12-42>;

The Media Access Control ID (MACID) is the physical address of the network card for the ethernet use. The MACID contains 4 or 6 two-digit hexadecimal numbers, separated by minus signs.

OPTIONS <DEF>;

The enhanced database options are: Real Application Cluster <RAC>, FailSafe <FS>, and DataGuard <DG>. DEF means default.

MAX_USERS <99999>;

MAX_USERS is the maximum number concurrent users allowed for the installation independent of the module where they are working.

MODULE <ADM> USERS <37> EXPIRES <13-JUL-2004>;

MODULE <E&PI> USERS <16> EXPIRES <25-AUG-2004>;

MODULE <MLCL> USERS <50> EXPIRES <19-SEP-2004>;

MODULE <MSCM> USERS <29> EXPIRES <19-SEP-2004>;

MODULE <Site> USERS <57> EXPIRES <19-SEP-2004>;

MODULE <Integrator> USERS <78> EXPIRES <19-SEP-2004>;

Each licensed module is listed with its:

Name

Maximum concurrent user count

Expiration date

LICENSE_KEY<ETJF73NFFMDV53Z3NFIAFDX5QC34534HSE744EWGTX8I0SZ9243TQK2RBR9SQ4TGJIDZTEWTZHBHPYVR142MVRF7CLBTHKYCTTOC2PEKV3NV3BC7H2TLNB558F1UVC2LVZ14J5345ZEZTUE9678000YS0BG2T87VCUBPHYHJMZ0A>;

The license key contains internal information.

Do not change any part of the license text received from Intergraph. If your license text is modified, SmartPlant Materials may lock users out of the database. After a license text is corrupted, you will need a new license text from Intergraph. You will not be able to simply reinstall the old one using A.60.81.


S E C T I O N 3

Request a License for a New SmartPlant Materials Environment

Run SmartPlant Materials in its own database. If you share a database for SmartPlant Materials and another application, the connections of the other application could get counted in the SmartPlant Materials license count.

Display the SmartPlant Materials web page. At the Logon screen, enter your username, password and a database alias. Typically, you use ‘LOGIN’ with the password ‘LOGIN’ that was created on installation.

After authentication, you can select a project / product group. The default (preinstalled) project is named M_PROJECT. Click OK. The project environment is not important for licensing.

A new SmartPlant Materials environment includes the following workflows:

Installing a new SmartPlant Materials database at a customer site using the Intergraph Best Practice Oracle export.

Installing a blank SmartPlant Materials database following the steps in the "SmartPlant Materials Database Fresh Installation" chapter in the Installation and Migration Guide.

Moving an existing SmartPlant Materials database to another Oracle database server at the customer site.

Renaming an existing SmartPlant Materials database.

Copying an existing SmartPlant Materials database to another named database on the existing Oracle database server.

Changing the machine name of the SmartPlant Materials Oracle database server.

If you are importing a SmartPlant Material database from an Oracle export, the inherited SmartPlant Materials license will not be correct, and the following error appears:

MAR-05009: License manager not configured correctly

If you are building the SmartPlant Material database manually and you currently have no data in the SmartPlant Materials database, you will encounter this error:

MAR-05001: No license number available.

In either case, click OK. SmartPlant Materials displays the A.60.81 License screen.

On the A.60.81 screen, click Request License.

If the license is already installed through SmartPlant License Manager, the following error message appears:

MAR-10308 Cannot request License.

Requesting and Installing New Licenses


Requesting and Installing New Licenses To resolve this error, go to the Install Through SPLM tab and un-install (return) the existing license. Then, request the license again.

On the License Request Data window, enter the required information to request a license from Intergraph.

Click No.

Click Yes.

1. Collect the following information from the text displayed on A.60.81.

Database Name (maps to DATABASE in license text)

Database ID (maps to DBID in license text)

Database SID (maps to SID in license text)

Hostname (maps to entry MACHINE in license text)

2. Collect the number of seats per module you have based on your PO. The following is an example:

1 seats of part SE**570 - SPRD Material Life

1 seats of part SE**574 - SPMat Eng & Proc

3 seats of part SE**578 - SPMat Supply Chain

3 seats of part SE**582 - SPMat Site Managmnt

1 seats of part SE**629 - SPMat Integrator

3. Send the above information along with your Company Name to:

[email protected]

Close the A.60.81 screen or click OK and then Return to logon.

Exit the logon screen, and wait for a response email from Intergraph.



Install a License When you have received the license text from Intergraph, you are ready to install the license.

Enter your username, password, and database, and select a project.

Click OK. SmartPlant Materials displays the A.60.81 License screen where you can enter license information.

Open the Intergraph email that contains the license text. The license text starts with the string LICENSE <SmartPlant Materials>. The last property in the license text is the LICENSE_KEY, which ends with a semicolon ( ; ).

Copy all the text from LICENSE to the ending semicolon and paste it into the License Text field on the A.60.81 screen (using the windows clipboard). Delete the ‘No license text available’ text string that is displayed in the License Text field. Leading and trailing blanks or empty lines do not matter; you may include them or leave them out.

Click Install License. A message box tells you that the installation of a license cannot be undone and cannot be redone. Click Continue.

At the ‘MAR-05011: License Text updated’ message, click OK.


Requesting and Installing New Licenses After successfully installing the license key, SmartPlant Materials displays feedback information.

Click Email and copy the contents of the Installation Feedback Data field into the email body (using the Windows Clipboard).

The feedback text includes the serial number, the installation status and a feedback code.

Send the email to [email protected]. Close the A.60.81 screen or click OK and then click Return to logon. You can now use SmartPlant Materials in the way you licensed it.

Intergraph receives your feedback, marks the license as ‘really used by the customer,’ and sends you a confirmation code by return email.

Enter the confirmation code within two weeks. If the confirmation code is not entered within two weeks, you will not be able to enter SmartPlant Materials. Until the confirmation code is entered, every logon user sees the following message:

MAR-05016: No Confirmation Code found. You have time until <DD-MON-YY> to enter it.

Enter Confirmation Code After you have installed the license text, Intergraph will send you a confirmation code that you must enter within two weeks.


Requesting and Installing New Licenses Open the A.60.81 License screen. This screen displays the actual license text. Click Enter Confirmation.

The Confirmation Code field contains the ‘!NVL’ text string. Replace this string by opening the confirmation email from Intergraph, and copying the confirmation code to the field (using the Windows Clipboard). Click Save to store the changes.

The licensing process has been completed now that the license and the confirmation code are installed.


S E C T I O N 4

Two weeks before your current SmartPlant Materials license expires, you will begin to receive a warning each time you log in:

MAR-05007: Your license will expire in n days

Customers will need to channel their license request through Intergraph eLicense.

If you are already using the eLicense web interface for other Intergraph products, you may choose to use this method to request the SmartPlant Materials license with: https://ppmapps.intergraph.com/ELICENSE/Logon.aspx.

If you currently do not use the eLicense web interface, you may request eLicense via email.

To renew your license via eLicense by email: Go to the A.60.81 screen.

The screen displays the license text. Click Request License.

If the license is already installed through SmartPlant License Manager, the following error message appears:

MAR-10308 Cannot request License.

To resolve this error, go to the Install Through SPLM tab and un-install (return) the existing license. Then, request the license again.

If there is already a license text installed, SmartPlant Materials asks if you want to renew the license with the same text.

Click Yes to set up an email template. Click Email and copy the resulting email into the template. Send this email to Intergraph.

Click No if you want to edit your license text. The confirmation box below displays.

Click No to display an email template ready for you to update expiration dates and user counts for your installation.

Renewing Your SmartPlant Materials Production License


Renewing Your SmartPlant Materials Production License 1. Collect the following information from the existing license. This information can be obtained

directly from the license text on the A.60.81 screen.

Database Name (maps to DATABASE in license text)

Database ID (maps to DBID in license text)

Database SID (maps to SID in license text)

Hostname (maps to entry MACHINE in license text)

2. Collect the number of seats per module you have based on your purchase order. The following is an example:

1 seats of part SE**570 - SPRD Material Life 1 seats of part SE**574 - SPMat Eng & Proc 3 seats of part SE**578 - SPMat Supply Chain 3 seats of part SE**582 - SPMat Site Managmnt 1 seats of part SE**629 - SPMat Integrator

3. Send the above information along with your Company Name to:

[email protected]

This email will be processed by the Intergraph Huntsville, Alabama office during their normal work hours, 7:30 to 4:15 US Central Time.

4. Follow the previous steps to install the license text, request the confirmation, and load the confirmation text.


S E C T I O N 5

SmartPlant License Manager (SPLM) provides license control for SmartPlant Materials (SPMat) and SmartPlant Reference Data (SPRD). This section explains the architecture and process for using SmartPlant License Manager.

Architecture The picture below shows how the SPLM license machine and SPMat servers are configured and installed.

To the left of the dotted line, you can see the typical deployment of SPLM and on the right hand side, you can see the deployment of SPMat (This could be SPMat or SPRD or both).

Here are some important points to remember:

The SPLM license machine interfaces with the SPMat/SPRD web application server, which connects to the database server.

The SPLM client is installed on the SPMat/SPRD web application server.

License Handling with SmartPlant License Manager


License Handling with SmartPlant License Manager The existing mechanism for license management in SPMat/SPRD is used in this

architecture.

Prerequisites The application server, database server, and SmartPlant License Manager license machine

must be nodes within the same network domain.

SmartPlant Materials 2011 R1 supports SmartPlant License Manager versions 11 and 12.

Installation For more information about SmartPlant License Manager installation, see the SmartPlant License Manager Installation and User’s Guide, which is delivered with SmartPlant License Manager.

1. Once the SmartPlant License Manager machine is installed, you must generate the machine ID.

2. Obtain your license key via eLicense.


License Handling with SmartPlant License Manager 3. Once you have received your key, you must install the license key using SmartPlant License

Manager.

4. Install the SmartPlant License Manager Client on the client machine. (In the case of

SmartPlant Materials, this will be on the application server machine.)


License Handling with SmartPlant License Manager 5. Select the Configure and Test and then Select License Machine for Client options, and

then type the computer name of the SPLM license machine in the License machine field.

6. To check if your SmartPlant License Manager client is able to communicate with the

SmartPlant License Manager license machine, you can select Configure and Test / Test Seat Reservation and Configure and Test / Test Seat Release as mentioned in the SmartPlant License Manager Installation and User’s Guide.

Keep the seat number in mind when you make a test seat reservation. You will need it for testing the seat release.



Product tag: MAT = SPMat, RD = SPRD



Process Using the SmartPlant License Manager functionality, you (an administrator) get and install the license for SmartPlant Materials/SmartPlant Reference Data. You can then work in the SmartPlant Materials/SmartPlant Reference Data software.

When the license is no longer needed, you can return the license to SmartPlant License Manager.

User Interface Use the A.60.81 License screen in SmartPlant Materials to request and return licenses.


License Handling with SmartPlant License Manager Request License 1. On the Install Through SPLM tab of A.60.81, fill in all the fields; they are mandatory. This

data is used to create the license.

Customer Number: Type 90001.

Start Date (via LOV F9): Select the license start date including all modules.

End Date (via LOV F9): Select the license end date (expiration date).

Options: Select the license installation option, which depends on how the database is configured. The Default option means that the database is on a single database node. The options and their acronyms are as follows:

Default (DEF)

Real Application Cluster (RAC)

Fail Safe (FS)

Data Guard (DG)

Each option has an acronym. The acronym appears in the License Text box.

2. In the DB Nodes block, specify the database node details based on the value in the Options field.

The details in this block are automatically filled in if the license already exists with the chosen installation option.

3. If necessary, add or modify the values in the SID and Machine fields. If you want to remove

an existing node from the license, click Clear Record . These operations are not allowed on the record with the details of the node on which the current session is running.



For the Real Application Cluster (RAC) and Data Guard options, you must enter values for the SIDs and machine names based on your database configuration. For the Fail Safe option, you cannot enter data in the SID field. The SID value of the machine on which the current session is running will be fetched automatically.

4. In the Modules block, enter the number of seats in the No of Seats field, and select the expiration date from the LOV in the Expires field for each relevant module. The available modules are listed below:

SmartPlant Materials Module

SmartPlant License Manager Tag

Description

SPMAT MAT Complete SmartPlant Materials

E&PI MEP Engineering & Procurement Interface BOM and Requisition

Integrator MIM Integrator

MLCL MLC Material Life Cycle Library (Standardization)

MSCM MSC Material Supply Chain Management (Procurement)

SITE MSM Site (Construction)

MSCM-SUPP MSU E-Supplier module

SPRD RD Complete SmartPlant Reference Data

5. After filling out the fields, click Request License.

The following algorithm is used to install the license utilizing the SmartPlant License Manager license machine.

If a license is already installed, the software warns the user.

The software validates the input. This process validates that all required fields are supplied and additionally:

The total number of seats is greater than or equal to the sum of the seats mentioned for individual modules.



The license start date cannot be a previous date, and the license end date must be later than or the same as the start date.

The expiration date of each individual module is within the range of the license start date and end date.

At least one of the modules is checked for license generation.

The software installs the license: This step follows all the existing required procedures for license text generation and installation up to feedback generation and installing the confirmation code.

The software displays the internal license information in the License Text box.

Return License 1. Click Return License to return seats back to the SmartPlant License Manager license

machine for future usage.

An alert appears, asking you to choose a return option.

2. Do one of the following:

Click Return All Seats to return all the seats booked for all the modules.



Or, click Select Seats to Return to open a new window where the available license modules are listed with the assigned number of seats.

3. If you clicked Select Seats to Return, type the number of seats you want to return to

SmartPlant License Manager in the Seats to Return field, and click Return Specified Seats.

The specified seats are returned, and a new license is generated with the updated seat details.

The status of each return seat attempt to SmartPlant License Manager is tracked and

written to a log file named SPLM_License_return_log_xxxx.log.

Seats may not be successfully returned to SmartPlant License Manager due to the following reasons:

Seat ID and GUID do not match

SmartPlant License Manager server or SmartPlant License Manager client machines are down

In these cases, the details of those seats are recorded internally and a new license is generated on SmartPlant Materials with a new serial number. The starting date of this new license will be the system date. The ending date remains unchanged. The expiration of the module to which the seat belongs to also remains unchanged.

The maximum number of users and seats for the modules will be calculated based on the number of seats that are not successfully returned.

If all the seats are not successfully returned or released to SmartPlant License Manager, no new license is generated.

SmartPlant License Manager log files display the logged in username and nodename from where the license is being installed or returned.



FAQ Question: If licenses that are currently checked out to SmartPlant Materials are due to expire in the next few days, can you have a new license key on the SmartPlant License Manager license machine while all current licenses are with SmartPlant Materials? Is it necessary for SmartPlant Materials to release back all checked out licenses (that are due to expire in the next few days) to the SmartPlant License Manager license machine for the SmartPlant License Manager license machine to have a new license/key (increased or decreased count)?

Answer: From the SmartPlant Materials point of view – since the license is already checked out, it does not care what happens on the SmartPlant License Manager license machine. So you can change the SmartPlant License Manager key without affecting SmartPlant Materials. Then, in a few days, when the SmartPlant Materials license expires, simply check out a new license from the currently existing SmartPlant License Manager.

So yes, you can have a new SmartPlant License Manager key installed on the SmartPlant License Manager license machine, and it is not required for SmartPlant Materials to release back all checked out licenses to the SmartPlant License Manager license machine for the SmartPlant License Manager license machine to have a new key installed.

If you have un-returned seats and it's not expired yet from the old key, and you have a new key installed, you will not be able to use the new seat until the old checked out seat expires.

Question: Does it matter if the new key being installed on the SmartPlant License Manager license machine has more or less seats when SmartPlant Materials is using currently checked out licenses?

Answer: SmartPlant Materials does not care if the new key has more or less seat counts on the SmartPlant License Manager license machine.

(This is different with PDS and all other SmartPlant products in which the SmartPlant License Manager license machine does care if less counts are in the new key while the old key has users using seats when you are installing it).

Troubleshooting In case of failure during license installation, check the following:

All servers are configured and installed and are available in the same domain as described in the Architecture (on page 21) section of this document.

Check that the SmartPlant License Manager client can connect to the SmartPlant License Manager license machine.

If license installation fails, search for the files splm_req_results.log and splm_ret_results.log on the SmartPlant Materials application server and send them to MSC for further support.

MAR-10301: SPLM Interface is not available This error means that the OLE component that integrates SmartPlant Materials with SmartPlant License Manager is either not installed or not registered on the machine acting as application server for SmartPlant Materials. Go to the home directory of SmartPlant Materials on the application server and check the following path: \bin\SPLM. You must find MarianSplmInte.exe in this folder. If it is not there, then it is an installation problem and installation has to be carried


License Handling with SmartPlant License Manager out properly again. If it is there, then probably it is not registered and you need to register this with the system registry.

MAR-10302: Failed while preparing argument list for SPLM interface Normally this error will not come up. If this occurs, this is an environment-related problem and development will have to debug it in that case.

MAR-10303: Failed while requesting for license to SPLM interface If installation of SmartPlant License Manager and SmartPlant Materials is done completely as mentioned earlier in this document, this problem will not come up. This error means that the call to the SmartPlant License Manager library functions failed. Check for pdliceo.lib in the system.

MAR-10304: Failed while receiving GUID from SPLM interface There is a problem with the license installed. The SmartPlant License Manager client and license machine are not installed properly.

MAR-10305: Failed while receiving seat identification from SPLM interface SmartPlant License Manager did not return a seat identifier in response to the request to reserve the seat. This could mean either no seats allocated for the module in the license text or all seats are in use and reserved. Please check your license text and license usage on the SmartPlant License Manager license machine.

MAR-10306: Failed while receiving response from SPLM interface Normally this error will not occur. If it does occur, it means that SmartPlant License Manager is not returning any message text in response to the request to reserve the seat. Basically, this failure will happen while retrieving message text coming back in response to a request made to the SmartPlant License Manager license machine.

MAR-10115: SPLM is not configured for module <RD/MAT> or no seats available This will occur when there is no seat available for the module shown in the message text.


A Architecture • 21

E Enter Confirmation Code • 16

F FAQ • 31 Flexibility of Expiration Dates • 9

I Install a License • 15 Installation • 22 Integration with Logon Screen • 8 Introduction • 7

L License Handling with SmartPlant License

Manager • 21 License Text Format • 11

M Modules Requiring Licenses • 7

P Prerequisites • 22 Process • 26

R Renewing Your SmartPlant Materials

Production License • 19 Request a License for a New SmartPlant

Materials Environment • 13 Requesting and Installing New Licenses •

13

S SmartPlant Materials Database

Configuration and License Counts • 7 Synchronization of Licenses • 9

T Troubleshooting • 31

U User Interface • 26

V Visibility on the A.60.81, A.60.82, and

A.30.04 Screens • 8

Index


smartplant materials and smartplant reference data license...

Documents