Valid from: 04/2016

SAP PLM Integration for NX

Installation and User Manual
ECTR 4.6
 Preface

SAP PLM integration for NX Installation and User Manual

Responsible for the content:

SAP SE, 04/2016
Copyright © SAP SE 2004-2016. All rights reserved.
SAP SE Logo is a registered trademark of SAP SE.
SAP PLM integration for NX Installation and User Manual
[10000029415 / EHB / ENU / V:02]

Neither this document nor parts thereof may be reproduced or forwarded without the express permis-
sion of SAP SE.
Technical and functional changes reserved.
The information contained in this documentation may be changed or supplemented without prior no-
tice.
If you have any questions or comments regarding this document, please submit these by e-mail. SAP
SE does not guarantee that this document is free of errors.
SAP PLM integration for NX contains software developed by the Apache Software Foundation
(http://www.apache.org/).

© DSC Software AG SAP PLM integration for NX Page 2 of 46

 Preface

Preface
Thank you for your interest in our software. This user manual explains the use of SAP PLM integra-
tion for NX and describes the standard functional scope.

Prerequisites
This description is based on the assumption that users are familiar with the use of the application and
SAP PLM. It is assumed that users are able to create, open, and modify documents and are aware of
the concepts of SAP PLM.

Directory Names
We use the default settings including the directory names created by the standard installation in ex-
planations. If you are using different names, you must replace these accordingly.
Since you can choose any installation directory, we use the synonym %PLM_INSTDIR%.

Your Comments are Always Welcome

We greatly appreciate your remarks and your criticism as a reader of this manual. Your opinion helps
us to continuously improve the software as well as the documentation.

SAP SE
Neutrottstr. 16
69190 Walldorf
Tel.: +49 (0) 62 27/ 34 - 0
Internet: www.sap.com

Registered Trademarks
Windows 7, Windows 8, Microsoft Word, Microsoft Excel and Microsoft PowerPoint are registered
trademarks of Microsoft Corp.
SAP and SAP PLM are registered trademarks of SAP SE.

All program names and designations used in this manual might also be registered trademarks of the
manufacturing companies and must not be used commercially or in any other way. Errors reserved.
SAP SE does not in any way represent or endorse explicitly or implicitly the completeness, accuracy,
reliability, suitability or availability of any of the information, products, services or graphics provided or
displayed here.
SAP SE assumes no liability for any kind of loss or damage including but not limited to indirect or con-
sequential damage, loss or damage resulting from loss of data or profits arising in connection with the
use of the information provided herein.
No part of this manual may be reproduced or copied in any form including print, photocopy or storage
and/or distribution in electronic form, without the express written permission of SAP SE.
SAP SE continuously develops its products further to offer you the greatest level of convenience pos-
sible. We therefore apologize for any inconvenience caused by differences between the manual and
the product.
NX is a registered trademark of Siemens Product Lifecycle Management Software Inc.

© DSC Software AG SAP PLM integration for NX Page 3 of 46

 Contents

Contents
1 Installation ..................................................................................................................................6
1.1 Introduction..........................................................................................................................6
1.2 About this Document ...........................................................................................................6
1.2.1 Purposes .........................................................................................................................6
1.2.2 Integration .......................................................................................................................6
1.3 System Requirements..........................................................................................................6
1.3.1 User Names and Passwords for Installation and Customizing...........................................6
1.4 SAP Front-End Installer .......................................................................................................7
1.5 Business Configuration Set ..................................................................................................7
1.6 Directory: %PLM_INSTDIR%\applications\ugs\sys\win\bin ...................................................8
1.6.1 start_application_ugs.exe.................................................................................................8
1.6.2 plm_ug.men .....................................................................................................................9
1.6.3 plm_ug.men for cloning ....................................................................................................9
1.6.4 plm_ug.tbr ..................................................................................................................... 11
1.6.5 plm++ug.dll .................................................................................................................... 11
1.6.6 ug_metric.def ................................................................................................................. 12
1.6.7 cgmdef.txt ...................................................................................................................... 12
1.6.8 default.txt ....................................................................................................................... 12
2 Overview of Functions ............................................................................................................. 13
2.1 ECTR ................................................................................................................................ 13
2.2 Original .............................................................................................................................. 13
2.3 Document .......................................................................................................................... 14
2.4 Additional Functions .......................................................................................................... 14
3 Further Functions in NX........................................................................................................... 15
3.1 Handling Components ....................................................................................................... 15
3.2 Mirroring Assemblies and Components .............................................................................. 15
3.3 Handling Part Families ....................................................................................................... 15
3.3.1 Generating a Part Family under NX................................................................................ 15
3.3.2 Numbering Part Family Children .................................................................................... 16
3.3.3 Enhanced Part Family Classification .............................................................................. 17
3.3.4 ExcelFamilyPartsAddin .................................................................................................. 17
3.3.5 Edit existing part families ............................................................................................... 18
3.3.6 Expand existing part family ............................................................................................ 19
4 Attribute Transfer ..................................................................................................................... 20
4.1 Transfer Boolean attribute values from NX to SAP ............................................................. 20
5 NX Environment Variables....................................................................................................... 21
5.1 User Exit Activation............................................................................................................ 21
5.1.1 User Exits for Components ............................................................................................ 21
5.1.2 User Exits for Native NX Functions ................................................................................ 21
5.2 Call-Backs ......................................................................................................................... 22
5.3 Script Definitions ................................................................................................................ 23
5.4 Warnings and Error Messages ........................................................................................... 23
5.5 Communication Check ....................................................................................................... 24
5.6 Load and Save Options ..................................................................................................... 25
5.7 Copy.................................................................................................................................. 30
5.8 CGM Generation ............................................................................................................... 31
5.9 Direct PDF Generation from NX Part Files ......................................................................... 33
5.10 Drawing Options ................................................................................................................ 36
5.11 Preview Generation ........................................................................................................... 38
5.12 NX Bookmark Options ....................................................................................................... 40
5.13 Part Family Options ........................................................................................................... 41

© DSC Software AG SAP PLM integration for NX Page 4 of 46

 Contents

5.14 License Options ................................................................................................................. 43

5.15 Transfer Boolean attribute values from NX to SAP ............................................................. 43
5.16 Viewing Options................................................................................................................. 44
5.17 Process Assignments ........................................................................................................ 45
5.18 Environment variables for cloning ...................................................................................... 46

© DSC Software AG SAP PLM integration for NX Page 5 of 46

 Installation

1 Installation
1.1 Introduction
SAP PLM integration for NX is quick and easy to install. For development purposes, you first create a
standard installation in an SAP system. You can test customer-specific modifications there. This mini-
mizes the risk of errors in the final installation.
You can adapt SAP PLM integration for NX to the customer-specific environment.

1.2 About this Document

1.2.1 Purposes
The Installation and User Manual provides all important information regarding the installation and post-
installation of the SAP PLM integration for NX. The functions will be explained in more detail.

1.2.2 Integration
A working SAP system and an installed ECTR are prerequisite for installing SAP PLM integration for
NX.

1.3 System Requirements

The following requirements must be met for the installation:
 You have one of the following operating systems installed:
 Windows 7
 Windows 8
 Windows 10
 You are using the following servers:
 SAP ECC 6.0 or higher with the following component level
 EA-APPL 605 SAPK-60511INEAAPPL
 EA-APPL 606 SAPK-60609INEAAPPL
 EA-APPL 616 SAPK-61604INEAAPPL
 EA-APPL 617 SAPK-61702INEAAPPL
 SAP Kernel Release 721 and above
 Client: SAP GUI, Version 7.30 or higher
 You are using the following NX versions:
 NX 8.5, NX 9.0, NX10

1.3.1 User Names and Passwords for Installation and Customizing

The following users are required for successful installation:
SAP system
 User with role SAP_ALL (incl. RFC authorization)
 User with development key (for BAdIs)

Operating system
 User with administrator rights

© DSC Software AG SAP PLM integration for NX Page 6 of 46

 Installation

1.4 SAP Front-End Installer

ECTR is installed in your system landscape via an SAP Front-End Installer.
 1. Start the file start_plm.exe with administrator rights.
 2. In the following dialog, choose the components to be installed.
 3. Follow the instructions in SAP Front-End Installer.

1.5 Business Configuration Set

Business Configuration Set DSCSAG/ECTR_NX is supplied with SAP PLM integration for NX:
 DSCSAG/ECTR_NX
 UDF
 UGD
 UGM
 UGN
 Defining the CAD window used for the resolution scenario:
 RES4
 SORTF
 Defining the CAD field abbreviations for the resolution scenario:
 RES4 UGS:A
 RES4 UGS:AG
 RES4 UGS:AI
 RES4 UGS
 RES4 UGS
 RES4 UGS:PG
 RES4 UGS:PI
 SORTF UGS:C
 SORTF UGS:CR
 SORTF UGS:DC
 SORTF UGS:G
 SORTF UGS:I
 SORTF UGS:R
 SORTF UGS:RC
 SORTF UGS:Y

 Defining the workstation application:

 UGI

© DSC Software AG SAP PLM integration for NX Page 7 of 46

 Installation

 View cluster for Customizing CAD desktop:

 UGS DEFAULT
The first link in the table calls up a general explanation. To activate the Business Configuration Sets
and integrate them into your SAP system, use the second link in the table:
Title Link
Business Configura- http://help.sap.com/saphelp_nw70ehp1/helpdata/de/cd/a22237406d183fe1000
tion Sets 0009b38f889/frameset.htm
Activating Business http://help.sap.com/saphelp_erp60_sp/helpdata/de/ab/720008774c11d395f20
Configuration Sets 0a0c930dcc1/content.htm?frameset=/de/6f/3c3f9afbef11d2958c00a0c930dcc1
/frameset.htm&current_toc=/de/d2/a22237406d183fe10000009b38f889/plain.h
tm&node_id=15

1.6 Directory: %PLM_INSTDIR%\applications\ugs\sys\win\bin

The start scripts and initialization files for the connection are available in this directory.
The system checks whether all files for starting an application are available.
SAP PLM integration for NX
 In directory %PLM_INSTDIR%\applications\ugs\customize\config, it executes script
plm_setenv.bat
 Imports the variables
 Checks whether default.txt exists

1.6.1 start_application_ugs.exe
Installation directory: %PLM_INSTDIR%\applications\ugs\basis\sys\win\bin\
 Processes the transferred call parameters
 Starts the client and the application
 Initializes the communication between ECTR and the application
Actions of the script
 Calls up the file and sets customer-specific variables
 %PLM_INSTDIR%\applications\ugs\customize\config\plm_setenv.bat
 Determines the installed version of the application by calling up the program
 <UGII_ROOT_DIR>\env_print.exe
 Copies the corresponding startup directory from
 %PLM_INSTDIR%\application\ugs\sys\win\ugsVxx\startup
to
 %PLM_TEMPROOT%\exec\ugs
 Sets the directory for the communication between ECTR and the application
 UGII_D_TEMPDIR=%PLM_TEMPDIR%
 This variable points to the directory:
 %PLM_TEMPROOT%\data
 Sets the variable for loading the plm++ug.dll, the menu file and the toolbar file:
 UGII_VENDOR_DIR=%PLM_TEMPROOT%\exec\ugs

© DSC Software AG SAP PLM integration for NX Page 8 of 46

 Installation

The following user exits have been implemented in plm_ug.dll:

User exit Description Environment variable Default setting
USER_RCOMP Adding a component PLM_USE_RCOMP Activated
USER_SCOMP2 Replacing a component PLM_USE_SCOMP2 Activated
USER_CCOMP Creating a component PLM_USE_CCOMP Activated
USER_RETRIEVE Opening a part PLM_USE_OPEN Deactivated
USER_CREATE Creating a part PLM_USE_CREATE Deactivated
USER_FILE Saving a part PLM_USE_SAVE Deactivated
USER_SAVEAS "Save as" for a part PLM_USE_SAVEAS Deactivated
USER_MERGE Importing a part PLM_USE_IMPORT Deactivated

 Sets the language for the text output of the messages in the application:
 UGII_D_LANGUAGE=%PLM_LANGUAGE
 Generates the language-specific menu file
 %PLM_TEMPROOT%\exec\ugs\startup\%PLM_UG_MENU%
from file
 %PLM_INSTDIR%\application\ugs\appdata\%PLM_UG_MENU
 Copies the toolbar file from
 %PLM_INSTDIR%\application\ugs\appdata\%PLM_UG_TOOLBAR%
to
 %PLM_TEMPROOT%\exec\ugs\startup
 Starts the application
 %PLM_UG_START%" %opencom%
Wait until the application has started and then activate ECTR.

1.6.2 plm_ug.men
Installation directory: %PLM_INSTDIR%\applications\ugs\appdata\
 Contains the specific menu entries for the application in German and English.
 Is processed when the application is started via ECTR. The result is a language-specific file in di-
rectory %PLM_TEMPDIR%\exec\ugs\startup
You can make changes to the specific menu entries for the application. To do this, you have to copy
the file and set the environment variable PLM_UG_MENU in
%PLM_INSTDIR%\applications\ugs\customize\config\plm_setenv.bat according to the
name of the new file you have created.

1.6.3 plm_ug.men for cloning

In the file plm_ug.men in the directory
%PLM_INSTDIR%\applications\ugs\customize\config,
must be defined the menu entries for the SAP PLM menu in NX.

© DSC Software AG SAP PLM integration for NX Page 9 of 46

 Installation

Menu configuration extract

VERSION 120
EDIT UG_GATEWAY_MAIN_MENUBAR

AFTER UG_FILE
CASCADE_BUTTON SAP
!EN LABEL SAP PLM
!DE LABEL SAP PLM
CASCADE_BUTTON DSC
!EN LABEL SAP PLM DSC
!DE LABEL SAP PLM DSC
END_OF_AFTER
!--------------------------------------------------------------------------
MENU SAP

BUTTON SAP_OPEN_OM1
!EN LABEL Open ECTR
!DE LABEL ECTR öffnen
!EN MESSAGE Open ECTR.
!DE MESSAGE ECTR öffnen.
BITMAP cfc_gui_logo24x24.bmp
ACCELERATOR Ctrl+Alt+Shift+O
ACTIONS 003_sap_open_obj_mgr

SEPARATOR

CASCADE_BUTTON SAP_ORIGINAL
!EN LABEL Original
!DE LABEL Original
!EN MESSAGE Functions for opening / saving / copying NX models with SAP PLM
!DE MESSAGE Funktionen zum Öffnen, Sichern und Kopieren von NX-Modellen mit
SAP PLM

SEPARATOR

CASCADE_BUTTON SAP_DOCUMENT
!EN LABEL Document
!DE LABEL Dokument
SEPARATOR

CASCADE_BUTTON SAP_ADDITIONALS
!EN LABEL Additional Functions
!DE LABEL Zusätzliche Funktionen

© DSC Software AG SAP PLM integration for NX Page 10 of 46

 Installation

BUTTON SAP_ABOUT
!EN LABEL About
!DE LABEL Info
BITMAP About_24.bmp
ACTIONS sap_about

BUTTON SAP_OPTION_MENU
!EN LABEL Settings
!DE LABEL Einstellungen
BITMAP Settings24.bmp
ACTIONS 049_sap_option_menu

SEPARATOR

END_OF_MENU
1.6.4 plm_ug.tbr
Installation directory: %PLM_INSTDIR%\applications\ugs\appdata\
 Contains the settings for the specific toolbar in the application.
You can make changes to the settings. Copy the
 plm_ug.tbr
and then set the variable
 PLM_UG_TOOLBAR
in
 %PLM_INSTDIR%\applications\ugs\customize\config\plm_setenv.bat.

1.6.5 plm++ug.dll
Installation directory:
%PLM_INSTDIR%\applications\ugs\basis\sys\win\ugsV<version>\startup\
 Is a program library.
 Contains the programming of ECTR.
If environment variable UGII_VENDOR_DIR is set in the start scripts of ECTR, the application loads
the library during startup. When the application is started, license ufun_execute must be reachable
while plm_ug.dll is loaded. If the license is not available, the message "Function is not registered"
appears when a menu command is executed.

© DSC Software AG SAP PLM integration for NX Page 11 of 46

 Installation

1.6.6 ug_metric.def
Installation directory: %UGII_ROOT_DIR%
 Defines the user settings, for example, the part names and version creation rules.
 ECTR offers you the option of using a definition file adapted to your specific requirements.
 To do this, you have to assign the name of the definition file in file
%PLM_INSTDIR%\applications\ugs\customize\config\plm_setenv.bat of variable
PLM_UG_DSCDEFAULTS:
 PLM_UG_DSCDEFAULTS=<file name>.def
 At runtime, variable UGII_DEFAULTS_FILE is set to file
%PLM_INSTDIR%\applications\ugs\appdata\<file name>.def.

1.6.7 cgmdef.txt
Installation directory: %PLM_INSTDIR%\applications\ugs\appdata\
 Defines the behavior during the generation of the CGM files when drawings are saved in the appli-
cation.
You can configure ECTR:
 The CGM generation takes place directly when the active session is checked in.
 The CGM generation takes place only in the conversion server.
In the application, you can use environment variable UGII_CGM_DEFAULTS to set which CGM
definition file is used.

Configuration Information
# Use REAL for maximum resolution
EXPORT_VDC_TYPE REAL
# Use INTEGER, if the software does not understand REAL.
EXPORT_VDC_TYPE INTEGER
# Replace all fonts after F1, except BLOCKFONT, which is mapped after F2.
EXPORT_TEXT_FONT ALL_UG_FONTS F1
EXPORT_TEXT_FONT BLOCKFONT F2
# Define the lines in the CGM as wider.
EXPORT_WIDTH_MODE SCALED
EXPORT_SCALED_WIDTH THIN 2.0
EXPORT_SCALED_WIDTH NORMAL 5.0
EXPORT_SCALED_WIDTH THICK 8.0

1.6.8 default.txt
Installation directory: %PLM_INSTDIR%\applications\ugs\customize\config\
 Contains variables that are generated for the session at runtime.
 Contains variables for the ECTR client.
For more information, refer to the actual file.

© DSC Software AG SAP PLM integration for NX Page 12 of 46

 Overview of Functions

2 Overview of Functions
2.1 ECTR
 Open ECTR
Go to ECTR.

2.2 Original
 New
Generates a new original.
 Open
To open an existing original, a search dialog is opened.
 Save
Saves the active NX part and saves the file in the SAP system. If you want to save parts, open the
parts with write rights. When you save, the document structure and the attributes are also updated
and previews are generated according to your settings. By default, the attributes are only updated
after re-opening. No neutral formats are generated during buffering. After saving, the document still
has write rights and is still open for editing. The parts stay open.
 Edit
If you want to edit a part, open it with write rights. Editing rights must be available.
 Save and Display
Saves the current part in the SAP system. After saving, the part is immediately re-opened as read-
only.
 Save as...
 Save as New Version
Saves the part as a new version. If the part is used in an assembly, the assembly references
the old version or the predecessor version of this part.
 Save as New Document
Saves the part and stores it as a new document in the SAP system and replaces all references
to the old part.
 Update
 Update Originals
Updates the current original.
 Update Originals with dialog
Updates the current original with the help of a dialog.
 Update Attributes
Updates the attributes for the selected part.
 Cancel and close
Closes the active part without saving the changes made. The SAP system is reset and all changes
are discarded. The change status is reset to the status the part had the last time it was saved.
 Import
Checks whether the selected part is available in SAP. If that is not the case, a dialog opens for cre-
ating the parts.
Note that the Import function in the ECTR ribbon in the CAD system allows only a simple upload of
CAD files into the SAP system. When you use this function, a Document Info Record is created
and the CAD files are attached as original. Do not use this function to handle offline collaboration
scenarios (send/receive CAD files to/from externals) or initial data imports during migration pro-
jects.

© DSC Software AG SAP PLM integration for NX Page 13 of 46

 Overview of Functions

2.3 Document
 Document
 Display Document
Opens the SAP PLM document info record for displaying the data.
 Add to object list
Opens a dialog to add the original to an object list..
 Open Original of Dependent Document
Opens the dependent document for the current part. If several documents are available, a se-
lection is displayed in list form.
 Create Dependent Document
Creates a new dependent document for the current part.

2.4 Additional Functions

 Bill of Material
 Display Bill of Material
Opens the Bill of Material for viewing in the SAP system.
 Create Bill of Material
Creates a Bill of Material which belongs to the active part..
 Edit Bill of Material
Edits the Bill of Material for viewing in the SAP system.
 Material
 Assign Material
If you are searching for materials and want to assign these to a part, SAP PLM integration for
NX opens a search dialog.
 Create Material
Generates a new material for the current part in the SAP system. The material is automatically
linked to the document via an object link. This requires the corresponding authorization for cre-
ating new materials in SAP.
 Display Material
If an object link between the document and a material exists for the current part, this function
opens the material in an SAP dialog. The data is displayed in the SAP dialog. Here, the part can
be either an assembly or an individual part.
 Info
Displays information about the current version.
 Options
Opens the options dialog in ECTR.
 Save and close part family instances
Saves all new generated or changed part family members into the SAP system.

© DSC Software AG SAP PLM integration for NX Page 14 of 46

 Further Functions in NX

3 Further Functions in NX
In NX, functions can be called in two different ways: either via the SAP PLM menu entry in the NX
menu bar or via the PLM_NX toolbar.
The PLM_NX toolbar in NX can be activated in two different ways:
 Via the NX menu command: Tools → Adjust
 By right-clicking on a toolbar and choosing the menu entry "Adjust." In the dialog that appears then,
you can choose the entry "PLM_NX" on the "Toolbars" tab. Closing the dialog activates the
PLM_NX toolbar.
Except for the instructions
Assemblies → Components DSCSAG/ECTR_NX Add Existing… | Generate New…
all other NX menu entries remain unchanged.

3.1 Handling Components

Engineering of assemblies is supported. The required components are selected in integration.
You can generate a new component or add an existing component. Integration makes the selected
component available to NX.

3.2 Mirroring Assemblies and Components

SAP PLM uses the function "Mirror Assembly..." to generate a mirrored version of the entire assembly
or of selected components. The new version is created as a new assembly or component in the SAP
system.
1) Select the mirrored component in the Assembly Navigator and save it in NX (Ctrl + S)
2) Select SAP PLM  Document  New  Create new parts
3) The Import dialog opens. Select the component to be imported and click OK.
4) The New document dialog opens. Create a new Master document of the document to be imported
in SAP PLM.
Upon completion of the import to SAP PLM, the mirrored component is displayed with the assigned
document number in the Assembly Navigator.

3.3 Handling Part Families

3.3.1 Generating a Part Family under NX
1) Create a master document for a part family.
2) Switch to the development application under NX.
3) Switch to engineering mode.
4) Call up the function via Tools  Part Families…
5) Ensure that Importable Part Family Template is not selected.
6) Choose the expressions and attributes that are required as columns in the spreadsheet.
The selection of expressions is used to model the 3D geometry.
If you want to specify the properties separately for each part, you can add attributes.
7) The part_name field is included in selected columns.
8) Choose Generate.
9) Choose Generate Part Family/Parts. The part family child is generated.
Note: The SAP system only takes into account the selected rows.
10) Choose Continue to go to the spreadsheet template.
11) Choose Save Part Family/Family. The spreadsheet is saved back to the part.

© DSC Software AG SAP PLM integration for NX Page 15 of 46

 Further Functions in NX

3.3.2 Numbering Part Family Children

The SAP system determines the document number for manual document creation with internal num-
ber assignment. The original is renamed and saved in the SAP system.
For children of part families, the complete name must first be defined in the part_name column.
External Number Assignment
You can define a separate document type that allows external numbering. You can use the DType
settings to prevent a part family child from being created interactively.
To do this, set preference variable UGII_A_FAM_PNAME_RULES to false.
Advantage:
This setting simplifies the handling of part family children if the part name of a new part family child
can be specified directly in the spreadsheet. The specified name implicitly results in the SAP docu-
ment number, which is why the required migrated templates require little post-processing.
Disadvantages:
Numbers can possibly be assigned twice.
If you use internal number assignment for other document types, the use of external number assign-
ment represents a discontinuity.

Internal Number Assignment

The names of the parts in the spreadsheet are generated via a function. The function creates docu-
ments in the SAP system and enters the generated numbers in the table as part names.
Advantage:
Consistency in numbering, if the other document types are also numbered internally. Using unique
numbers means that there is no risk of duplicates.

Disadvantage:
The DIRs must be created using an additional functionality beforehand. Later on, as many part family
children must be generated as DIRs were created.
You have to integrate an additional menu in Microsoft Excel.Execute the following file:
ExcelFamilyPartsNET.msi
The file can be found here:
%PLM_INSTDIR%\applications\ugs\appdata\FamilyPartsAddin.NET\x64 bzw. x86
Restart the SAP system.

Part Names of Part Family Children

If you want to create versions of the part family children, you have to enter the fully qualified part name
in the part_name column. You can thus distinguish different child versions in the part name.
If you do not require versions, you can set fixed values for the document type, part document number
and version. In this case, the name suffices as the document number.
If you have set up external number assignment, you no longer have to post-process migrated tem-
plates. In the other cases you have to add <Doc.Type><Part_doc.>_<Version> between
".prt" and the document number.
If templates are migrated with a new internal number, the entire part_name column has to be revised.
For part family assemblies you must also check the references to components.

© DSC Software AG SAP PLM integration for NX Page 16 of 46

 Further Functions in NX

3.3.3 Enhanced Part Family Classification

You have the option of immediately classifying the generated part family children at the time of gener-
ation. In doing so, you have to enter the classification as follows in the NX spreadsheet:

 Part_Name: Class information. Use a separator to separate the class type from the class name.
For MARA classes, the assigned part family member material is determined and then classified.
The class is NOT created anew. Ensure that the class and characteristics exist in the SAP system.
 Under the individual parameters (p0, p1, p2) enter the corresponding characteristic that is filled with
the entered value.
Required preference variables in file default.txt:
# Separator- can be any character string
UGII_A_FAM_ADV_CLASSIFY_IDENT = !
# Activation of the enhanced part family classification
UGII_A_FAM_ADV_CLASSIFY = true
# Identifier for the material class in the spreadsheet
UGII_A_FAM_ADV_CLASSIFY_MARA = MARA
# Identifier for the document class in the spreadsheet
UGII_A_FAM_ADV_CLASSIFY_DRAW = DRAW

3.3.4 ExcelFamilyPartsAddin
Installation
Installation by registering Office COM add-in ExcelFamilyPartsAddin.dll is possible on any
client PC. The file is located in …\applications\ugs\appdata\. The registration is executed us-
ing ExcelFamilyPartsAddin_install.bat in the local client copy of the integration. Make sure
you have local administrator rights. Under Windows 7, the registration must be executed in a console
that the user started as administrator.
The setting is made via ExcelFamilyPartsAddin.ini. There, buttons can be activated or deac-
tivated and the displayed labels can be changed in the menu.

© DSC Software AG SAP PLM integration for NX Page 17 of 46

 Further Functions in NX

Functions
Create Family Member document
Placeholder documents are created for the part family member to be created. The document numbers
generated there are entered in the selected data records.
Possible Selection in the Excel Sheet:
 Direct selection of all desired cells
 Selection of entire rows (the relevant cell is identified using the "Part_Names" column header)
Provide Components
For all selected data records, the originals are made available in the session directory.
Possible selection in the Excel sheet:
 Direct selection of all cells that contain the document number
 Selection of entire rows (the relevant cell is identified using the "Part_Names" column header)
Provide+Create (sheet)
This corresponds to "Provide Components;" the function "Generate Parts" is called automatically from
the NX part family menu in Excel after the provision.
Possible selection in the Excel sheet:
 Selection of entire rows (the relevant cell is identified using the "Part_Names" column header)
Update Part Name
The document number of the selected data records is updated.
Possible selection in the Excel sheet:
 Direct selection of all cells that contain the document number
 Selection of entire rows (the relevant cell is identified using the "Part_Names" column header)

3.3.5 Edit existing part families

Just as with assemblies, it is possible to extend existing part families.
Note: For these steps, the SAP PLM Family menu is required for Microsoft Excel.

Approach:
 Open the part family to be changed for editing in ECTR.
 In NX, select Tools – Part Families.
The Part families window opens.
In this window,
 deselect the option Importable Part Familiy Template
 select the desired columns for the Excel tables
 execute the Edit function.

The Excel table opens.

 Change the desired part family member.
 Markieren Sie das gewünschte Teilefamilienmitglied.
 In the SAP PLM Family menu, select function Provide Components.

© DSC Software AG SAP PLM integration for NX Page 18 of 46

 Further Functions in NX

A message appears that indicates the number of available components.

 Click OK.

In the Excel table, select the Update parts function in the Part Families menu.
In NX,
 click the Resume function in the Part Families window.
 execute the Save families function in the Part Families menu.
 save the changed part family member in ECTR:
SAP PLM – Document – New – Create part family member.
The part family member has been changed according to your entries.

3.3.6 Expand existing part family

 Open the part family for editing in ECTR.
 In NX, select Tools – Part Families.
 In the Part Families window, click the Edit function.

The Excel table opens.

In this table,
 create a new row.
Important: Do not fill out the cell in the Part_name column.
 select the cell in the Part_Name column.
 in the SAP PLM Family menu, select the Create Family Member DIRs function.
A new number has been entered in the cell.
 Select this row.
 Execute the Create parts function.
 In NX, click the Resume function in the Part families window.
 Execute the Save families function in the Part Families menu.
 In NX, select SAP PLM – Document – New – Create part family member.
The new member has been created in the part family.

© DSC Software AG SAP PLM integration for NX Page 19 of 46

 Attribute Transfer

4 Attribute Transfer
The attribute transfer is used to write various pieces of information from the SAP system to the appli-
cation file. This information is linked in the frame of the drawing. The application references the attrib-
utes using the "Annotation Editor" (Menu -> Insert Text).
You can specify an attribute name, which is then placed in the drawing. The attribute value is visible
and is displayed in case of an update via the attribute transfer.
You have to place the attributes in the template file that was defined when the drawing was created.
The definition which templates are available is located in the following section in the DType file:
<primary_application attribute_section="MASTERMODEL“...>
<document_create>
<seedfile filename="DIN-A0-NX3.prt" type="template"…>
<description language="DE" text="A0 Zeichnung" />
<description language="EN" text="A0 size drawing" />
</seedfile>
</document_create>

4.1 Transfer Boolean attribute values from NX to SAP

For the correct output of Boolean attribute values, the corresponding environment variables must be
set as follows:
UGII_D_ATR_BOOL_TRUE=T
UGII_D_ATR_BOOL_FALSE=F
By setting the environment variables like this, the SAP system displays the values T and F.

© DSC Software AG SAP PLM integration for NX Page 20 of 46

 NX Environment Variables

5 NX Environment Variables
The following list of NX environment variables is a snapshot of the scope of functions at the time the
product was released by SAP PLM Integration to NX in version 4.5. Due to ongoing development of
the software, the type and scope of this list may change.

5.1 User Exit Activation

User exits are automatically set via AutoIT. Hence, the following user exits do not have to be set man-
ually. If they are set nonetheless, the values set automatically via AutoIT are overwritten. The varia-
bles can be set manually here:
%PLM_INSTDIR%\applications\ugs\customize\config\plm_setenv.bat

5.1.1 User Exits for Components

Variable Description
USER_RCOMP Before inserting a component.
Value
%PLM_UGDIR_VOS%\startup\plm++ug.dll
USER_SCOMP2 Before exchanging a component.
Value
%PLM_UGDIR_VOS%\startup\plm++ug.dll
USER_CCOMP Before generating a component.
Value
%PLM_UGDIR_VOS%\startup\plm++ug.dll

5.1.2 User Exits for Native NX Functions

In file ugs\customize\config\plm_setenv.bat you have the option of deactivating the native
NX functions or redirecting them to other functions by means of additional user exits.
Variable Description
USER_RETRIEVE Before opening a part.
Value
%PLM_UGDIR_VOS%\startup\plm++ug.dll
USER_CREATE Before creating a part.
Value
%PLM_UGDIR_VOS%\startup\plm++ug.dll
USER_FILE Before saving a part.
Value
%PLM_UGDIR_VOS%\startup\plm++ug.dll
USER_SAVEAS Before executing 'save as' for a part.
Value
%PLM_UGDIR_VOS%\startup\plm++ug.dll
USER_MERGE Before importing a part.
Value
%PLM_UGDIR_VOS%\startup\plm++ug.dll

© DSC Software AG SAP PLM integration for NX Page 21 of 46

 NX Environment Variables

5.2 Call-Backs
Variable Description
UF_save_part_reason Whenever a part is saved, ECTR writes the necessary SAP
information into a new XML file and saves this into the directo-
ry that has the same name as the part file (without .prt).
UF_create_part_reason If a part has been created, ECTR checks whether the file ex-
ists. If that is not the case, UF_PART_save is called. In this
event, dependent on environment variable
UGII_D_CRE_USE_SEED, a template is imported, in which
variable UGII_D_CRE_SEEDPART can be defined.
UF_open_part_reason This is used to execute various actions after opening a part.
Example
UGII_D_ATR_OPENEVENT = true
means update attributes
UF_change_work_part_reason ECTR starts a script if variable
UGII_D_WP_USE_SCRIPT = true
is set.
The script is called:
plm_changeworkpart.bat
<'Additonalverzeichnis des workparts'>
With this script you can set e.g. a drive letter such as "W:\"
with the DOS command subst on the working directory. This
makes it easier for users to store data there.
UGII_D_CB_IGNORE_RENAME Ignore the renaming of the call-back
Value
true / false
UGII_D_NOCALLBACKS Ignore all call-backs
Value
true / false
UGII_D_CB_IGNORE_SAV Ignore save call-back
Value
true / false
UGII_D_CB_IGNORE_MOD Ignore edit call-back
Value
true / false
UGII_D_CB_IGNORE_CRE Ignore create call-back
Value
true / false
UGII_D_CB_IGNORE_OPEN Ignore open call-back
Value
true / false
UGII_D_CB_IGNORE_CW Ignore change work part call-back
Value
true / false

© DSC Software AG SAP PLM integration for NX Page 22 of 46

 NX Environment Variables

5.3 Script Definitions

Variable Description
UGII_D_PLM_STARTEXE Start ECTR. This variable contains the .bat or .csh file that
starts ECTR.
Example
UGII_D_PLM_START =
C:\dscsag\ectr\basis\sys\win\bin\start_plm.exe
File
%PLM_INSTDIR%\applications\ugs\customize\config\
plm_setenv.bat
UGII_D_WP_USE_SCRIPT ECTR starts this script when the part is changed. To do this, the NX
call-back "change work part" is used. The script could then e.g. set
drive W: (for work part) on the additional directory of the part. ECTR
calls the script with the name of the part as the first parameter.
Value
<Name of a batch file>
File
%PLM_INSTDIR%\applications\ugs\customize\config\
default.txt

5.4 Warnings and Error Messages

File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt
Variable Description
UGII_D_ADD_ERROR If this variable is set to true, an error is output if the
user wants to add a component to a read-only assembly.
Value
true: Error is output
false: Error is not output
UGII_D_ADD_WARNING If this variable is set to true, a warning is output if the
user wants to add a component to a read-only assembly.
Value
true: Warning is output
false: Warning is not output
UGII_D_CRE_ERROR If this variable is set to true, an error is output if the
user wants to generate a component in a read-only as-
sembly.
Value
true: Error is output
false: Error is not output
UGII_D_CRE_WARNING If this variable is set to true, a warning is output if the
user wants to generate a component in a read-only as-
sembly.
Value
true: Warning is output
false: Warning is not output

© DSC Software AG SAP PLM integration for NX Page 23 of 46

 NX Environment Variables

Variable Description
UGII_D_CONFIRM_CANCEL_CHECKOUT If this variable is set to true, a confirmation dialog is dis-
played if the user wants to cancel a change without sav-
ing. This happens for the following menu entries in the
SAP PLM menu:
 Close work part and discard work
 Close work part with components and discard work
 Close everything and discard work
Value
true: Confirmation dialog is displayed
false: Confirmation dialog is not displayed (default)
UGII_D_SAVE_WARN_WP This variable is used to determine whether a warning is
to be output when a part is buffered if the components of
the part are editted and read-only.
Value
true: A warning is output for editted read-only com-
ponents.
false: No warning, if components of the WP are edit-
ted and read-only.

5.5 Communication Check

File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt
Variable Description
UGII_D_SLEEPTIME Defines the wait time (milliseconds) in the XML communication be-
tween NX and the ECTR client.
Value
<Number between 10 and 1000>
UGII_D_ATR_FN_SAP Defines the name of the attribute file for the attributes in CAD that are
transferred to SAP.
Value
plm_metainf-sap.xml
UGII_D_ATR_FN_CAD Defines the name of the attribute file for the attributes in SAP that are
transferred to NX.
Value
plm_metainf-cad.xml
UGII_D_WRITE_XML_IF_ Specifies whether an attribute file is only written if an additional directo-
ADDDIR_EXISTS ry already exists for the document. Otherwise, a missing additional
directory is created before writing the attribute file.
Value
true: Write attribute file only if an additional directory exists.
false: Create missing attribute directory prior to writing the attribute
file.
UGII_D_ATR_REAL_ Defines the number of decimal digits.
PREC Value
<Number> z.B. "8.
UGII_D_ATR_REAL_ Defines if the unit is displayed next to the number.
W_UNIT Value
true: Display unit
false: Do not display the unit (default)

© DSC Software AG SAP PLM integration for NX Page 24 of 46

 NX Environment Variables

Variable Description
UGII_D_ATR_REAL_ Defines if the value is displayed in exponential form if necessary.
SHOW_EXPO Value
true: Display in exponential form.
false: Do not display in exponential form (default).
UGII_D_ENHANCE_ Defines if drag&drop or a usual AddComponent is performed. If
ADDCOMP_VIA_ drag&drop is recognized, the user-exit will be terminated so that no
DRAGDROP AddComponent dialog appears.
Value
true/false

5.6 Load and Save Options

File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt
Variable Description
UGII_D_IGNORE_PROOF_OF_ Specifies whether the check of the NX application under
VALID_APP which the file may be stored (e.g. UF_APP_GATEWAY or
UF_APP_DRAFTING) is to be skipped. If this variable is not
set to true this means that e.g. under kinematics
(UF_APP_MECHANISMS) saving is not executed and a
message appears for changing the active application for sav-
ing.
Value
true / false
UGII_D_POS_APPLIST_ADD Specifies which NX application may additionally be used for
saving (default: UF_APP_GATEWAY, UF_APP_DRAFTING,
UF_APP_MODELLING, UF_APP_CAM, UF_APP_SFEM).
The number of the application is visible via the NX log after
the attempt to save in an application that is not checked (or
which cannot be checked) by DSC.
Value
e.g. 1025 (UF_APP_FLEX_PCB)
UGII_D_SAV_UPD_ATTR Specifies whether all attributes from SAP are to be imported
again prior to saving. If you have purchased the additional
module ++batchEngine then set this variable to false.
Value
true / false
UGII_A_SEARCHDIRS This variable can be used to enhance the NX search path
with additional directories. This can be necessary, e.g. if you
have to store SAP parts for certain third-party products in
other directories.
Value
<Search directories>
UGII_D_SAVE_ BACKGROUND This "buffer" function can be configured so that NX becomes
active again as soon as the job has been sent to the client. It
does not wait for the result of saving to SAP. However, the
client does display errors.
Value
true / false

© DSC Software AG SAP PLM integration for NX Page 25 of 46

 NX Environment Variables

Variable Description
UGII_A_IGNORE_CMOD Controls whether external references such as the user-
defined features are to be stored as external references in
SAP. However, the prerequisite for this is that user-defined
feature parts are also managed via SAP. If user-defined fea-
ture parts are not managed via SAP, the variable must be set
to false. Otherwise, you might get the error "Part is not known
in SAP" when you try to save.
Value
true / false
UGII_D_CRE_USE_SEED After creating a component, ECTR in NX can also be made
to import a template and set the layers.
Value
true / false
UGII_D_CRE_SEEDPART Specifies which template part is to be additionally imported
after creating a component.
Value
%PLM_INSTDIR%\applications\ugs\templates\
model-mm.prt
UGII_D_SAV_EXT_MOD_RO Specifies whether all editted, read-only parts are displayed in
a table prior to saving.
Value
true / false
UGII_D_OPEN_USE_M Specifies whether a macro is supposed to be used to open
parts.
Value
true / false
UGII_D_OPEN_M Defines the name of the macro.
<Macro name> e.g.:
%PLM++INSTDIR%/applications/ugs/templates/
open.macro
UGII_D_ATR_OPENEVENT Specifies whether the attributes are to be updated when parts
are opened in the call-back.
Value
true / false
UGII_D_ATR_UPD_RW_PARTS Specifies whether the attributes are to be updated when RW
parts are opened using the default OPEN function.
Value
true / false
UGII_D_ATR_UPD_RO_PARTS Specifies whether the attributes are to be updated when RO
parts (read-only) are opened using the default OPEN func-
tion.
Value
true / false
UGII_D_FAMMBR_UPDATE_ATR Specifies whether the attributes are to be updated when part
families are opened using the default OPEN function.
Value
true / false
UGII_D_ATR_UPD_REGEN_MOD_ Activates a "regenerate" after the attribute update.
VIEW Value
true / false

© DSC Software AG SAP PLM integration for NX Page 26 of 46

 NX Environment Variables

Variable Description
UGII_LATEST_COMPONENT_ In case of "Open as" of an assembly in ANT, the user exit is
VERSIONS_ON_OPEN_AS activated. If you then load an assembly with a higher version
in ECTR and this assembly has other parts than those that
are currently loaded, these parts are not replaced. To ensure
that the lower components are also replaced, you have to set
this variable to "1".
Value
0 or 1
UGII_UPDATE_WITH_VERSION_ If you execute the function "Update Assembly" in NX, an
NAMES "Update Structure" is executed if at least one component is
not loaded. However, NX does not replace the versions for
unloaded parts in the default. This variable must be set to "1"
to make NX do this anyway.
Value:
0 or 1
UGII_D_ACP_MAT_SEARCH Makes it possible to switch between the default search for
materials and documents.
Value
true (search for material)
false (search for document)
UGII_A_SUPP_COMPS Specifies whether components with the attribute "sup-
pressed" are taken into account in NX integration. Among
other things, suppressed components are also written into
the plm++metainf-cad.xml file, so that they are then
updated in the SAP system and displayed within the assem-
bly in ECTR.
NOTE: By default, the suppressed components are not taken
into account in NX integration.
Value
true / false
UGII_A_NONGEO_COMPS Specifies whether components with the attribute "not geomet-
ric" are taken into account in NX integration. Among other
things, non-geometric components are also written to
plm++metainf-cad.xml (additional attribute of the CHILD
element: NONGEOMETRIC = true), so that these are then
updated in the SAP system and displayed within the assem-
bly in ECTR.
NOTE: By default, non-geometric components are not taken
into account in NX integration.
Value
true / false
UGII_D_WRITE_BBOX Specifies whether bounding box values and the subsequent
bounding box attributes are written into plm++metainf-
cad.xml when saving. The edges of the bounding box are
aligned in parallel to the axles of the absolute system of co-
ordinates. Siemens states that incorrect values can occur if a
body is trimmed or it is the result of a Boolean operation.
Value
true / false

© DSC Software AG SAP PLM integration for NX Page 27 of 46

 NX Environment Variables

Variable Description
UGII_D_BBOX_TO_ATTR_NAME Name of the additional attribute in the plm_metainf-cad.xml,
which contains the length, width and height of the bounding
box in the following form: <length>x<width>x<height>
Highest value = length
Medium value = width
Smallest value = height
Value
NX_DIMENSION (Standard)
UGII_D_BBOX_TO_ATTR_NAME_X Name of the additional attribute in plm_metainf-cad.xml,
which contains the length.
Value
NX_DIMENSION (Standard)
UGII_D_BBOX_TO_ATTR_NAME_Y Name of the additional attribute in plm_metainf-cad.xml,
which contains the height.
Value
NX_DIMENSION (Standard)
UGII_D_BBOX_TO_ATTR_NAME_Z Name of the additional attribute in plm_metainf-cad.xml,
which contains the width.
Value
NX_DIMENSION (Standard)
UGII_D_BBOX_TO_ATTR_UNIT Unit of the attribute value for the dimensions of the bounding
box
Default settings for decimal places:
Meter  3
Decimeter  2
Centimeter  1
Millimeter  0
UGII_D_BBOX_TO_ATTR_PRECISION=3 overwrites the
default settings
Value
M, DM, CM, MM
UGII_D_BBOX_TO_ATTR_SHOW_ Specifies whether the unit of the attribute value is to be dis-
UNIT played for the dimensions of the bounding box.
Value
true / false
UGII_D_BBOX_TO_ATTR_ONLY_ Specifies for which document type the attribute with the di-
FOR mensions of the bounding box is to be created and therefore
written into plm_metainf-cad.xml.
Value
Semicolon-separated list of document types
(e.g. UKM; UGM)
UGII_D_SURFACE_ATTR Specifies the attribute name of the area.
Value
Any name (if blank or not set, no area calcu-
lation takes place.)
Required NX license: adv_assemblies
UGII_D_SURFACE_UNIT_CM Controls the unit of measure of the area information.
Value
true (cm²) / false (m²)

© DSC Software AG SAP PLM integration for NX Page 28 of 46

 NX Environment Variables

Variable Description
UGII_D_SURFACE_PRECISION Specifies the number of decimal places for the area units.
Value
Any numeric value
UGII_D_SURFACE_FOR_REFSET If reference sets are used in NX, this variable specifies for
which of these reference sets the area is calculated.
Value
Name of the reference set
UGII_D_WEIGHT_ATTR Specifies the attribute name for the weight.
Value
Any name (if blank or not set, no weight cal-
culation takes place.)
Required NX license: adv_assemblies
UGII_D_WEIGHT_UNIT_GRAM Controls the unit of measure of the weight.
Value
true (gram) / false (kilogram)
UGII_D_WEIGHT_PRECISION Specifies the number of decimal places for the weight infor-
mation.
Value
Any numeric value
UGII_D_WEIGHT_FOR_REFSET If reference sets are used in NX, this variable specifies for
which of these reference sets the weight is calculated.
Value
Name of the reference set
UGII_D_VOLUME_ATTR Specifies the attribute name for the volume.
Value
Any name (if blank or not set, no volume cal-
culation takes place.)
Required NX license: adv_assemblies
UGII_D_VOLUME_UNIT Controls the unit of measure of the volume
Value
MM3 (default) / CM3 / M3 / DM3
UGII_D_VOLUME_PRECISION Specifies the number of decimal places for the volume infor-
mation.
Value
18 (default) / any numeric value
UGII_D_VOLUME_SHOW_UNIT Outputs the attribute value with the unit.
Value
true / false (default)
UGII_D_VOLUME_FOR_REFSET If reference sets are used in NX, this variable specifies for
which of these reference sets the volume is calculated.
Value:
Name of the reference set
UGII_D_PART_SELECTION_ Specifies how a part is selected for opening/adding/replacing.
METHOD Value
NX: NX dialog
ECTR: Java dialog (default value)
CDESK: NX dialog, adjusted for CAD Desktop

© DSC Software AG SAP PLM integration for NX Page 29 of 46

 NX Environment Variables

Variable Description
UGII_D_REPLACE_WITHOUT_ New alternative procedure for replacing components. Avoids
NATIVE the problem that the selection of the component to be re-
placed is lost. From NX 7.5.5 onwards, this is no longer re-
quired because the error has been resolved as of this ver-
sion.
Value
true / false
UGII_D_SAV_DO_FORCE_UPD_ Triggers that views are always updated when saving - irre-
VIEWS spective of whether they are out of date or not.
Value
true / false
UGII_D_SAV_CLEANUP Automatically cleans up parts every time you save.
Value
true / false
UGII_D_CLEAN_VAR1 Together with variable UGII_D_SAV_CLEANUP, extended
part cleanup is performed, incl. mating cleanup.
Value
true / false
UGII_D_CLEAN_EXPR Together with variable UGII_D_SAV_CLEANUP, extended
part cleanup is performed incl. unref. expression cleanup.
Value
true / false
UGII_D_COMPATTR_TO_SAP The component attributes that are written to ECTR can be
filtered in a semi-colon separated list. All other component
attributes would be invisible in ECTR (SAP). If the environ-
ment variable remains blank, all available attributes are writ-
ten to ECTR (performance-relevant).
Value
IGNORE;POSNR
UGII_D_ATR_UPDATE_LOAD_ Defines whether components are loaded to perform an attrib-
PART ute update.
Value
true / false
UGII_D_IOD_WRITE_ALL_PARTS Defines whether natively designed parts, which haven’t been
_TO_PLM saved on hard disk or in the SAP system previously, respond
to "Import on Demand".
Value
true / false

5.7 Copy
File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt
Variable Beschreibung
UGII_D_MAKE_UNIQUE_COPY_ALL_NM When copying a document after the usage of the „Make
Unique“ function in NX, this variable defines if the de-
pendent documents are also copied during the process.
Values:
true/false

© DSC Software AG SAP PLM integration for NX Page 30 of 46

 NX Environment Variables

5.8 CGM Generation

File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt
Variable Description
UGII_A_SHEET_VALID Specifies whether a CGM/preview is only generated for
certain drawings. ECTR checks whether the drawing starts
with one of the texts that are separated with ";" in this vari-
able.
Value
<TEXT>;<TEXT>;…
Example
PAGE_;SHEET_
In this example, a CGM/preview is generated for all draw-
ings that start with "PAGE_" or "SHEET_". For all drawings
with different names, the CGM/preview generation is sup-
pressed.
UGII_D_CGM_COLOR Defines whether a single-color or multi-color CGM is to be
generated.
Value
 0: Use black for all geometries.
 1: Use the displayed colors.
 2: Use colors from the part color table.
 3: Use the colors determined for the session.
 4: Use black for all geometries.
 5: The first three entries (recognizable by thin, normal
and thick) determine the colors for the session. In other
words, the color is determined by the thickness index. All
thin objects are drawn with the first color entry, all normal
objects with the second color entry and all thick objects
with the third color entry.
UGII_D_CGM_CREATE Specifies whether or not a CGM is to be generated for each
drawing during check-in to the SAP system.
Value
true: Automatic CGM generation is deactivated
false: Automatic CGM generation is activated
UGII_D_CGM_MIN_S Specifies whether generated CGM files with less than the
set value in bytes are deleted again immediately, i.e. not
stored in SAP. For example, if you set the value to 3000,
no CGM is generated for empty drawings.
Value
<Number bytes>
UGII_D_CGM_MULTIPAGE Generates multi-page CGMs when saving.
Value
true / false
UGII_D_CGM_NOTATSAVE This variable can be used to deactivate CGM generation
when buffering
Value
true: A CGM is generated during buffering
false: No CGM is generated during buffering

© DSC Software AG SAP PLM integration for NX Page 31 of 46

 NX Environment Variables

Variable Description
UGII_D_CGM_PEN_1 Settings for the pen assignment in CGM.
Value
UGII_D_CGM_PEN_1=1
UGII_D_CGM_PEN_2 Settings for the pen assignment in CGM.
Value
UGII_D_CGM_PEN_2=2
. .
. .
UGII_D_CGM_PEN_15 Settings for the pen assignment in CGM.
Value
UGII_D_CGM_PEN_15=15
UGII_D_CGM_PNAME You can use this variable to specify whether the file name
of the CGM file is supposed to contain the part name in
addition to the drawing name. If the part name is inserted
into the file, the copy process in ECTR must be configured
so that the CGMs are deleted. In file default.txt, vari-
able plm.document.copyas.ignore.wsappl = CGM
must be set.
Value
true: CGM file name also includes the part name
false: CGM file name only consists of the name of the
drawing
UGII_D_CGM_POLY Defines whether the texts are to be stored as contour defi-
nitions or texts in the CGM files.
Value
true: The texts are stored as text in CGM
false: The texts are stored as contour definitions in CGM
UGII_D_CGM_SEP This variable defines the separator between the drawing
name and the part name if CGM is supposed to contain the
part name.
Value
<Separator>
Example
UGII_D_CGM_SEP=_
UGII_D_CGM_UPDATE_VIEWS Has the effect that the views that have NX status "Ou-
tOfDate" are updated during saving for preview/CGM gen-
eration.
Value
true / false

© DSC Software AG SAP PLM integration for NX Page 32 of 46

 NX Environment Variables

Variable Description
UGII_D_CGM_WIDTH Defines the line width of a CGM.
The line width can be defined customer-spefic with a WDF
file. Which WDF file is used can be set with the variable
UGII_D_CGM_CUST_FILE.
Value
 1 UF_CGM_STANDARD_WIDTHS (default):
Use 3 fixed lines
 2: UF_CGM_SINGLE_WIDTH:
Use single line width that has been defined in the user-
defined settings
 3: UF_CGM_CUSTOM_3_WIDTHS:
Use user-defined widths per width index according to the
settings in the user-defined widths. Additional parameter
-cgm_width_custfile <filename> specifies the
file name of the user-defined width/color file (default
custom_width_color.txt). This overwrites the
default widths.
 4: UF_CGM_CUSTOM_PALETTE_WIDTHS:
Apply user-defined widths as per color palette. Additional
parameter -cgm_width_custfile <filename>
specifies the file name of the user-defined width/color file
(default custom_width_color.txt). This overwrites
the default widths.
 5: UF_CGM_DEFAULT_FILE_WIDTHS:
Apply line width settings specified in the CGM default file
(cgmdef.txt.
UGII_D_FAM_CREATE_CGM Specify whether a CGM file is to be generated when saving
a family template in NX with "Save Part Family (DP)."
Value
true: CGM file is generated
false: Do not generate CGM file
UGII_D_FAM_MEMBER_CREATE_CGM Specifies whether CGM files are to be generated with the
NX part family children are generated.
Value
true: CGM file is generated
false: Do not generate CGM file (default)

5.9 Direct PDF Generation from NX Part Files

It is possible to generate PDFs directly via NXOpen (without the manual detour via CGM). This makes
it possible for text that can be changed subsequently to be stored in the PDF and not be saved as a
vector graphic. This is used for the following processes. From NX 7.5 onwards, the following environ-
ment variable must be set to save real texts that can be changed subsequently:
UGII_PDF_NO_HIDDEN_TEXT=1
Program:
++convert.exe:

© DSC Software AG SAP PLM integration for NX Page 33 of 46

 NX Environment Variables

Example: ++convert -p zylinder.prt -pdf -d c:\temp

Variable Description
UGII_D_PDF_SIZE Specifies the size of the PDF document. If the size is set to scale,
the PDF uses the user-defined scaling factor.
If the size is set to dimension, the PDF uses the user-defined X and
Y measurements.
Value
0: SizeOptionFullScale/** Full Scale */,
1: SizeOptionScaleFactor/** Scale Factor */ (Default)
2: SizeOptionDimension/** Dimension */
UGII_D_PDF_UNITS Specifies the units of the X and Y measurements used if Dimension
is selected in the size selection.
Value
0: UnitsOptionMetric/** Metric */ (Default)
1: UnitsOptionEnglish/** English */
UGII_D_PDF_OUTPUT_TXT Determines the output text of the PDF. This is used to specify
whether the drawing text is exported as a text or as polylines.
Value
0: OutputTextOptionText/** text stays text */ (Default)
1: OutputTextOptionPolylines/** text is turned into polylines */
UGII_D_PDF_IMG_RES Specifies the resolutions of views of generated images that have
been shaded for export.
Value
0: ImageResolutionOptionDraft/** Draft Resolution */, (Default)
1: ImageResolutionOptionLow/** Low Resolution */,
2: ImageResolutionOptionMedium/** Medium Resolution */,
3: ImageResolutionOptionHigh/** High Resolution */
UGII_D_PDF_WIDTHS Specifies the width. If the width option is set to Single Width, Custom
Three Widths or Custom palette, the PDF document is generated
with the user-defined width attributes of the width definition object.
Individual width values are set with the following environment varia-
ble:
UGII_D_PDF_CUST_WDF
Value
0: WidthStandardWidths/** Default Widths */,
1: WidthSingleWidth/** Single Width */,
2: WidthCustomThreeWidths/** Custom Three Widths */,
3: WidthCustomPalette/** Custom palette */
UGII_D_PDF_CUST_WDF UGII_D_PDF_CUST_WDF = D:\temp\widths.wdf (for example) If
UGII_D_PDF_WIDHTS is set to 3 (Custom palette) then use must
define the pallet file.
This variable is used to address the file in the file system.

© DSC Software AG SAP PLM integration for NX Page 34 of 46

 NX Environment Variables

Variable Description
UGII_D_PDF_COLORS Sets the color scheme to be used when the PDF document is gener-
ated. If the color option is set to Custom Palette or Colors By Width,
a PDF document is generated
with the user-defined color attributes that belong to the CDF object.
Value
0: ColorAsDisplayed/** As Displayed */,
1: ColorPartColors/** Part Colors */,
2: ColorCustomPalette/** Custom Palette */,
3: ColorBlackOnWhite/** Black on White */,
4: ColorLegacyColors/** Legacy Colors */,
5: ColorColorsByWidth/** Part Colors */
UGII_D_PDF_SCALE Sets the scaling factor to be used when the PDF document is gener-
ated. This value ranges from 0.00 to 1.00 and is only used if the set
option is set to Scale.
Value
1 (Default)
UGII_D_PDF_XDIM Sets the X measurement to be used if Dimension has been selected
as the size option.
Value
8,5 (Default)
UGII_D_PDF_YDIM Sets the Y measurement to be used if Dimension has been selected
as the size option.
Value
11 (Default)
UGII_D_PDF_RASTERIMG Sets the grid images option. This option determines whether grid
images are exported to the PDF document or not.
Value
true (Default) / false
UGII_D_PDF_WATERMARK Sets the watermark text. This user-defined text only appears as a
watermark if Add Watermark is set to true.
Value
“” (Default)
UGII_D_PDF_SHADED_GEO Switches the Shaded Geometry option to wire-frame mode. If it is set
to true, the option displays shaded objects as wire-frame models.
The shaded objects are set to shaded if this option is set to false.
Value
true / false (Default)

© DSC Software AG SAP PLM integration for NX Page 35 of 46

 NX Environment Variables

5.10 Drawing Options

File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt

Variable Description
UGII_D_ATR_DRWATTR Specifies whether drawing-specific part attributes
are available. Drawing-specific attributes can be
used to set different texts on different drawings in
an NX file. An example of this is the descriptive text
that can be maintained differently for every drawing
in SAP.
Value
true: With drawing-specific part attributes
false: Without drawing-specific part attributes
UGII_D_ATR_FMT_TO_PARTATR Writes a part attribute of the first sheet. The value
corresponds to the sheet format/size e.g. "A4". If
the value height/width is "near" that e.g. of "A4",
then "A4" is specified. This information can be
overwritten customer-specifically, e.g. with
UGII_D_ATR_SHT_FORMAT.height.width=B12.
Value
E.g. FORMAT = 14
UGII_D_ATR_SCL_COMBINED_TO_PARTATR If UGII_D_ATR_VIEW_SCALES_TO_PARTATR is
set as well, this optimized scaling information is
output. The top scale is leading and the additional
scales then follow in brackets. A scale value only
occurs once.
Value
E.g. MASSSTAB_VIEWS_OPT=1:2 (2:3;2:5)
UGII_D_ATR_SCL_PREFIX Sets the specified prefix in front of the scaling for
all following scale variants.
 UGII_D_ATR_SHT_SCL_NAME,
UGII_D_ATR_SHT_SCL_NUMBER,
UGII_D_ATR_SCL_TO_PARTATR,
UGII_D_ATR_VIEW_SCALES_TO_PARTATR,
UGII_D_ATR_SCL_COMBINED_TO_PARTATR
Value
E.g. UGII_D_ATR_SCL_PREFIX=X
UGII_D_ATR_SCL_TO_PARTATR Writes a part attribute into the part that is being
saved with the specified name. The value is the
scale of the 1st drawing
Value
E.g. MASSSTAB=1:2
UGII_D_ATR_SHT_SCL_NAME Writes a part attribute for each valid sheet. The
specified attribute name is supplemented with "."
and the name of the sheet. The value corresponds
to the scale.
Value
E.g. MASSSTAB:Blatt1=2:1

© DSC Software AG SAP PLM integration for NX Page 36 of 46

 NX Environment Variables

Variable Description
UGII_D_ATR_SHT_SCL_NUMBER Writes a part attribute for each valid sheet. The
specified attribute name is supplemented with "."
and a sequential sheet number. The value corre-
sponds to the scale.
Value
E.g. MASSSTAB:2=4:1
UGII_D_ATR_VIEW_SCALES_TO_PARTATR Writes a part attribute with the scales of all views
for the first sheet. The leading scale is the top view
(termination after a max. of 132 characters)
Value
true: Delete blank drawing sheets.
false: Do not delete blank drawing sheets.
(Default)
UGII_D_DELETE_SHEETS_WITHOUT_VIEWS Specifies whether blank drawing sheets without
views that can occur in the callout linking function
are deleted again.
Value
true: The drawing contains the hidden edge ge-
ometry; hence the drawing is loaded without com-
ponents.
false: The drawing does not contain the hidden
edge geometry. ++batchEngine removes the re-
quired models from SAP and loads the drawing
with components.
UGII_D_EDG_CREATE When saving drawings, ECTR can be made to
save the hidden edges for each view in the file.
When drawings are sent, you do not necessarily
have to send the models as well. The
++batchEngine module knows two options for
view file generation.
Value
true: The drawing contains hidden edge geome-
try; hence the drawing is loaded without compo-
nents
false: The drawing does not contain the hidden
edge geometry. ++batchEngine removes the re-
quired models from SAP and loads the drawing
with components
UGII_D_SCALE_FROM_DLG Write sheet scales without conversion specified in
the dialog into the part attribute defined via
UGII_D_ATR_SHT_SCL_NAME. Affects
 UGII_D_ATR_SHT_SCL_NAME
 UGII_D_ATR_SHT_SCL_NUMBER
 UGII_D_ATR_SCL_TO_PARTATR

© DSC Software AG SAP PLM integration for NX Page 37 of 46

 NX Environment Variables

5.11 Preview Generation

File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt

Variable Description
UGII_D_PRV_MODEL You can use this variable to specify whether a preview is to be gen-
erated for models when they are saved.
Value
true: Previews are generated for models
false: Previews are generally not generated for models
UGII_D_PRV_DRAW You can use this variable to specify whether previews are to be gen-
erated for models when they are checked in.
Value
true: Previews are generated for valid drawing sheets
false: Previews are generally not generated for drawing sheets
UGII_D_PRV_NOTATSAVE This variable can be used to deactivate the preview generation when
buffering.
Value
true: No preview is generated during buffering
false: A preview is generated during buffering
UGII_D_PRV_MODEL_ Specifies whether a preview for the drawings is to be additionally
DRAW generated for the model geometry during check-in.
Value
true: If at least one valid drawing is available, a model preview is
also generated
false: No additional model preview for drawings
UGII_D_PRV_MODEL_ Specifies the name of the preview for the model.
NAME Value
<Preview-Name>: (Default: zmodel)
UGII_D_PRV_MODEL_X You can use this variable to specify the size of the previews.
UGII_D_PRV_MODEL_Y Value
<Integer>
Example
UGII_D_PRV_MODEL_X=500
UGII_D_PRV_MOD_EXT Specifies which preview format is to be generated for the models.
Value
gif: A GIF preview is generated (low resolution, but smaller than
JPG)
jpg: A JPEG preview is generated (higher resolution but slightly
bigger than GIF)
tif: TIF G4 format. The client then requires an additional JAR ar-
chive JimiProClasses.jar (TIF viewer) for displaying these previews
UGII_D_PRV_MODEL_ Uses a screenshot (hard copy) to generate the previews. Is used for
USEIMAGE the resolution of the graphic window in NX. Because of this proce-
dure, no "shading license" is required.
Value
true: Screen excerpt from the model
false: Rendering of the preview screen

© DSC Software AG SAP PLM integration for NX Page 38 of 46

 NX Environment Variables

Variable Description
UGII_A_SHEET_VALID You can use this variable to specify that a preview is to be generated
only for certain drawings. ECTR checks whether the drawing starts
with one of the texts that are separated with ";" in this variable.
Value
<TEXT>;<TEXT>
Example
PAGE_;SHEET_
In this example, a preview is generated for all drawings that start with
"PAGE_" or "SHEET_". The preview generation is suppressed for all
other drawings.
UGII_D_PRV_DRAW_ALL Specifies whether a preview is to be generated for each valid draw-
ing or only for active, valid drawings.
Value
true: A preview is generated for each valid drawing
false: A preview is generated only for the active drawing that is
currently visible. "drawing" + extension
UGII_D_PRV_DRW_EXT Here you can specify the format for the drawing previews.
Value
gif: GIF preview is the preferred format, small and sufficiently "high
resolution"
jpg: JPEG format generates rather large files and does not offer
"higher resolution" images than GIF (in 2D mode)
tif: TIF G4 format is generated as the preview format. The client
then requires an additional JAR archive JimiProClasses.jar (TIF
viewer) for displaying these previews
UGII_D_PRV_SHT_PREFIX Specifies the prefix or the file name for drawing previews. Here, the
following rules apply depending on the preference variable
UGII_D_PRV_DRAW_ALL:
 UGII_D_PRV_DRAW_ALL = true
If NX previews are generated for all drawing sheets, the prefix is
inserted before the sheet name.

Example
UGII_D_PRV_SHT_PREFIX = PROTOTYP_

The result then looks e.g. as follows:

PROTOTYPE_Sheet1.gif
PROTOTYPE_Sheet2.gif
PROTOTYPE_Engineering-drawing.gif
PROTOTYPE_Production-drawing.gif

 UGII_D_PRV_DRAW_ALL = false
Here, the preference variable specifies the entire file name for the
drawing preview.

Example
UGII_D_PRV_SHT_PREFIX = PROTOTYP-draw

The result then looks e.g. as follows:

PROTOTYPE-draw.gif

© DSC Software AG SAP PLM integration for NX Page 39 of 46

 NX Environment Variables

Variable Description
UGII_D_PRV_RM_STR In the generation of the preview files, it is possible to truncate the
ending of the sheet names. This makes sense in particular if the
sheet names contain the number of sheets such as
SHEET_1_OF_3. ECTR replaces previews in SAP by using the rela-
tive file name.
Value
<Text from which the sheet name is to be truncat-
ed. Here e.g. _OF>
UGII_D_SAV_DO_FIT_ Adjusts the model to the screen size if previews are generated from
MODELIFDRAW drafting mode.
Value
true: The model is adjusted to the screen size
false: The model is not adjusted to the screen size
UGII_D_SAV_DO_VIEW Prior to saving/the preview, this changes the view to the view set e.g.
"TOP" for the top view.
Value
TRIMETRIC; TOP; ISOMETRIC; LEFT; FRONT; RIGHT;
BACK; BOTTOM

5.12 NX Bookmark Options

File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt

Variable Description
UGII_A_BM_ENABLE Specifies whether ECTR is also supposed to manage the bookmark
files. To do this, ECTR monitors the directory
%PLM_DATADIR%\user\<username>\bookmarks
and saves all files in SAP in the system document of the user (<SAP
LOGINNAME>_LU SYD 000 00). When ECTR is opened for the first
time, the directory is updated with the bookmarks from SAP.
Value
true/false
UGII_A_BM_DELETE Specifies whether bookmark files are to be deleted or not after saving in
SAP.
Value
true/false
UGII_A_BM_DOC_TYPE In NX, bookmarks can also have previews. The workstation application
for the previews can be entered here.
Value
Identification of the workstation application e.g. JPG
UGII_A_BM_ZIP_APPL ECTR zips the bookmark files when saving them in SAP. The work-
station application under which the file is to be stored in SAP is speci-
fied here.
Value
Identification of the workstation application e.g. ZIP
UGII_A_BM_ZIP_EXT Specifies the extension for the ZIP file.
Value
File extension, e.g. ZIP

© DSC Software AG SAP PLM integration for NX Page 40 of 46

 NX Environment Variables

5.13 Part Family Options

File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt

Variable Description
UGII_A_FAM_DIR Specifies the directory for part families. In this
directory, new part family members are generat-
ed. ECTR only saves part family members that
are in the specified directory back to SAP.
Value
<Directory, e.g.
%PLM_TEMPDIR%/family>
UGII_D_FAM_DIR_AT_START Has the effect that the part family directory is set
from UGII_A_FAM_DIR during startup. During
the creation, the correct directory is displayed in
the part family dialog.
Value
true/false
UGII_A_FAM_ADMIN Defines which users are administrators for part
families. When a part family is opened, the
search path is enhanced with the part family
directory (UGII_A_FAM_DIR) only for users that
are listed in this variable.
Value
<SAP user name>
UGII_A_FAM_DType Specifies with which DType the newly created
part family member is to be stored in SAP.
Value
<DType, such as MOD or EINZE>
UGII_A_FAM_DTYPE = <MEMBER_DTYPE> Specifies the default part family DType
UGII_A_FAM_DTYPE_<TEMPLATE_DTYPE> = Specifies the part family DType depending on
<MEMBER_DTYPE> the template DType.
UGII_A_FAM_DESCR Specifies which NX attribute is to be used for the
description of the document in SAP.
Value
<NX attribute, such as SAP_DESCRIPTION>
UGII_A_FAM_MAT_ATTR Specifies which NX attribute contains the mate-
rial number with which the part family member is
to be linked.
Value
<UG attribute, such as
SAP_MATERIAL_LINK>

© DSC Software AG SAP PLM integration for NX Page 41 of 46

 NX Environment Variables

Variable Description
UGII_A_FAM_SAVEAS Determines whether ECTR allows "Save as" for
part family members or not. If "Save as" is per-
mitted for part family members you must take
into account the fact that part family members
cannot be changed in NX. In NX; a "ECTR Save
as" must thus be executed. A "Save as" in
ECTR does not suffice because this only copies
the file but does not remove the internal NX
member flag.
Value
true/false
UGII_A_FAM_AUTHGRP_FROM_TEMPL Specifies whether the authorization group for
part family members is to be copied from the
part family template.
Value
true/false
UGII_A_FAM_AUTHGRP_FIX Specifies the authorization group that the part
family members are to receive when they are
generated. This setting only takes effect if
UGII_A_FAM_AUTHGRP_FROM_TEMPL =
false
Value
<Authorization group>, default: ""
UGII_A_FAM_ADV_CLASSIFY_TYPE_MARA Specifies the class type for MARA (default 001)
UGII_A_FAM_ADV_CLASSIFY_TYPE_DRAW and DRAW (default 017) in the Excel table.
UGII_A_FAM_ADV_CLASSIFY_TYPE_<CLASS> <CLASS> can also be used to define a class
type that differs from MARA or DRAW
Value
Separate SAP class type, e.g. Z17

© DSC Software AG SAP PLM integration for NX Page 42 of 46

 NX Environment Variables

5.14 License Options

File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt

Variable Description
UGII_D_DONT_TERMINATE_API Specifies how the license server is used for checking
during the NX session.
Value
true: At runtime, the interface no longer terminates
UGOPEN-API, which retains the initialization until the end
of the runtime of NX. This has the effect that the check on
the license server only takes place once per session.
false: The environment within the NX session is initial-
ized and terminated for each function as required during
work.
UGII_D_DONT_REL_LIC Specifies how fetched licenses are returned.
Value
true: Any reserved/fetches licenses are no longer re-
turned manually from the interface. Due to this, licenses
can be in use even though they are currently not being
used. The only advantage of this is an improvement in the
speed.
false: The environment manually returns re-
served/fetched licenses at the end of a function.

5.15 Transfer Boolean attribute values from NX to SAP

File for setting the variable:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt

Variable Beschreibung
UGII_D_ATR_BOOL_TRUE For the correct output of Boolean attribute values of part
attribuites, the corresponding environment variables must
be set with T for true.
Value:
true: In the SAP system the value T is
displayed.
UGII_D_ATR_BOOL_FALSE For the correct output of Boolean attribute values of part
attribuites, the corresponding environment variables must
be set with F for false.
Werte:
false: In the SAP system the value F is dis-
played.

© DSC Software AG SAP PLM integration for NX Page 43 of 46

 NX Environment Variables

5.16 Viewing Options

File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt

Variable Description
UGII_D_WRITE_EXTENDEDINFOFILE Specifies whether a file is to be written with extended
viewing data. This is only required when viewer integra-
tion is used via the additional module PLM++ViewX.
Value
File name, e.g. plm_metainf-viewing.xml
UGII_D_WRITE_ARRANGEMENT Specifies whether NX arrangement information is to be
written.
Value
true/false
UGII_D_WRITE_REFDATA Specifies whether information is to be written via NX ref-
erence sets. NX reference set data can’t be determined in
a CAM application.
Value
true/false

© DSC Software AG SAP PLM integration for NX Page 44 of 46

 NX Environment Variables

5.17 Process Assignments

The following list shows the assignment between ECTR processes and client processes. This list
should be changed only if you want to replace a ECTR standard process with a customer-specific
process. In most cases, however, it suffices to use the defined BAdIs to make customer-specific en-
hancements.
UGII_D_THEME_0001 = plm.proc.cad.PlmProcessCadDocumentMasterCreate
UGII_D_THEME_0002 = plm.proc.cad.PlmProcessCadDocumentNonMasterCreate
UGII_D_THEME_0003 = plm.proc.cad.PlmProcessCadDocumentSave
UGII_D_THEME_0004 = plm.proc.PlmProcessOpenObjectManager
UGII_D_THEME_0005 = plm.proc.cad.PlmProcessCadDocumentCheckout
UGII_D_THEME_0006 = plm.proc.cad.PlmProcessCadDocumentSaveAsNewVersion
UGII_D_THEME_0007 = plm.proc.cad.PlmProcessCadDocumentSaveAs
UGII_D_THEME_0008 = plm.proc.cad.PlmProcessCadDocumentCancel
UGII_D_THEME_0009 = plm.proc.cad.PlmProcessCadMaterialMasterCreate
UGII_D_THEME_0010 = plm.proc.cad.PlmProcessCadMaterialMasterChange
UGII_D_THEME_0011 = plm.proc.cad.PlmProcessCadMaterialMasterDisplay
UGII_D_THEME_0012 = plm.proc.cad.PlmProcessCadMaterialBomCreate
UGII_D_THEME_0013 = plm.proc.cad.PlmProcessCadMaterialBomChange
UGII_D_THEME_0014 = plm.proc.cad.PlmProcessCadMaterialBomDisplay
UGII_D_THEME_0015 = plm.proc.cad.PlmProcessCadEcmCreate
UGII_D_THEME_0016 = plm.proc.cad.PlmProcessCadEcmChange
UGII_D_THEME_0017 = plm.proc.cad.PlmProcessCadEcmDisplay
UGII_D_THEME_0018 = plm.proc.cad.PlmProcessCadDocumentDisplay
UGII_D_THEME_0019 = plm.proc.cad.PlmProcessCadOpenOffice
UGII_D_THEME_0020 = plm.proc.cad.PlmProcessCadDocumentNonMasterOpen
UGII_D_THEME_0021 = plm.proc.cad.PlmProcessCadDocumentUpdateAttributes
UGII_D_THEME_0022 = plm.proc.ug.PlmProcessUgFamilySave
UGII_D_THEME_0023 = plm.proc.cad.PlmProcessCadClone
UGII_D_THEME_0024 = plm.proc.cad.PlmProcessCadUpdateAssemblyPartsSeparatly
UGII_D_THEME_0025 = plm.proc.cad.PlmProcessCadDocumentChange
UGII_D_THEME_0026 = plm.proc.cad.PlmProcessCadProductStructureDir
UGII_D_THEME_0027 =
plm.proc.cad.PlmProcessCadProductStructureMaterialMaster
UGII_D_THEME_0028 = plm.cdesk.PlmProcessCdeskShow
UGII_D_THEME_0029 = plm.proc.cad.PlmProcessOnlineHelp
UGII_D_THEME_0030 = plm.proc.cad.PlmProcessCadDocumentCheckoutMulti
UGII_D_THEME_0031 = plm.proc.cad.PlmProcessCadOptionMenu
UGII_D_THEME_0032 = plm.proc.cad.PlmProcessCadComponentOpen
Alternative: plm.proc.cad.PlmProcessCadComponentOpen but
UGII_D_OPEN_COMP_USE_WITH_STR_UPDATE=false is prerequisite for that! This process is
quicker but no version update or structure updates are performed!
UGII_D_THEME_0033 = plm.proc.cad.PlmProcessCadCheckReadOnlyParts
UGII_D_THEME_0034 = plm.proc.cad.PlmProcessCadCreateBomMultilevel

© DSC Software AG SAP PLM integration for NX Page 45 of 46

 NX Environment Variables

UGII_D_THEME_0035 = plm.proc.cad.PlmProcessCadDocumentReplaceByExpression
UGII_D_THEME_0036 = plm.proc.cad.PlmProcessCadNonVariantReplace
UGII_D_THEME_0037 = plm.proc.cad.PlmProcessCadDrawingUpdatePosnr
UGII_D_THEME_0038 = plm.proc.cad.PlmProcessUgSavePartslistInSap
UGII_D_THEME_0039 = plm.proc.cad.PlmProcessCadDocumentSearchAndOpen
UGII_D_THEME_0040 = plm.proc.cad.PlmProcessCadAddComponent
UGII_D_THEME_0041 = ENTFALLEN
UGII_D_THEME_0042 = plm.proc.PlmProcessShutdown
UGII_D_THEME_0043 = plm.proc.cad.PlmProcessCadInspectionPlanSave
UGII_D_THEME_0044 = plm.proc.cad.PlmProcessCadInspectionPlanOpen
UGII_D_THEME_0045 = plm.proc.cad.PlmProcessCadInspectionPlanSelect
UGII_D_THEME_CU01 = plm.proc.cad.PlmProcessCadCustWp01
…
UGII_D_THEME_CU05 = plm.proc.cad.PlmProcessCadCustWp05

5.18 Environment variables for cloning

File for setting the variables:
%PLM_INSTDIR%\applications\ugs\customize\config\default.txt
Variable Description
UGII_A_ATTR_REPLACED Defines the attribute name in NX.
UGII_D_DTHEME_GET_SUCCES Called process from the CAD side.
SOR Value
plm.proc.cad.PlmProcessCadDocumentDetermineSuccessorCom
ponents
UGII_D_REPLACE_BY_SCS_ Defines whether the entire structure is included or the top level
COMPLETE_STR only.

© DSC Software AG SAP PLM integration for NX Page 46 of 46