Professional Documents
Culture Documents
Teamcenter 11.2
NX Remote Manager
PLM00123 • 11.2.3
Contents
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Getting started
NX Remote Manager provides the ability to share data between customers and suppliers using My
Teamcenter to import and export data to directories that can be accessed by users outside of the
Teamcenter environment. In addition, you can use NX Remote Manager to work offline and then
synchronize data with the Teamcenter database.
1 Teamcenter client
2 NX Remote Manager
3 Remote application users
4 Supplier site
5 Teamcenter server
6 Remote individual user
NX Remote Manager uses export directories to manage the connections used to import and export
data. Files that are explicitly checked out for the current connection are exported with read-write
permission. Files that are not explicitly checked out are exported as read-only reference files.
When you import files back in to Teamcenter, only those files that have been checked out can be
imported back in to the database. This is referred to as high security and it applies to all files that are
managed by a connection.
Export rules
Option Description
Add Exports the primary dataset file, its component files, and
any additional files to the connection.
If the primary file is already in the connection, the system
does not check if any of the component files or additional
files must be updated or replaced due to changes in the
system. It ignores the Add function for that file.
Resend Exports the selected file, its component files, and
any additional files to the connection export directory,
overwriting files that are already in the directory.
Any modifications you have made to the files in the
connection export directory are lost. Use Resend
only when you are sure that you want to discard file
modifications. Files not previously exported to the
connection are added.
Refresh Checks to see if the selected files have been modified
in the system since the last export to the connection.
If modified, the system exports the selected files, the
associated components, and any additional files to the
connection. Files previously exported to the connection
are treated as if the Add option was used.
Analysis results
After performing an analysis prior to import, the system displays any of the following results.
The check mark indicates that the dataset analysis was successful.
The warning symbol indicates that an unusual condition was found during the analysis
of the dataset.
For more information about using the wza.exe utility, see the 7-Zip product documentation.
UNIX systems:
• Use the UNIX at command.
To use the at command, your name must appear in the usr/lib/cron/at.allow file. If that file
does not exist, the usr/lib/cron/at.deny file is checked to determine whether you should be
denied access.
If the at.deny file exists and is empty, global usage is permitted.
If neither file exists, only users with superuser authorization can submit a job.
2. Ensure that the user has the same login credentials on the remote system that they do on their
local system.
3. Ensure that the values of the TC_ROOT and TC_DATA environment variables are identical on
all computers.
4. Ensure that the connection directory is accessible using exactly the same path information on
all computers.
Note
Underscores in generated part numbers are converted to spaces.
Note
Spaces in generated names are converted to underscores.
Note
The UGII_BASE_DIR and UGII_ROOT_DIR environment variables must be set to export
item revisions containing UGMASTER datasets. If NX is installed locally, these variables
are set automatically. However, if you access the NX network from a mapped drive, you
must manually set these environment variables.
5. Select the components in the assembly that you want to download or check out.
You can force all items in a selected branch to default to Download Only, Download and
Checkout, or neither, in which case the component is not exported. If the component is already
checked out, or if you do not have write privileges to the dataset, you are not allowed to select
the checkout option.
• Exports the primary named reference file(s) of the corresponding dataset to the connection
export directory.
If the dataset is the root of an assembly, the selected component files are exported.
You can export, add, resend, or refresh the connection from this dialog box.
3. Click OK.
The system begins the analysis process to determine what files to export and to check for errors.
Before exporting any files, the system analyzes each dataset. When the analysis is complete, the
dialog box shows the list of datasets and the results for each.
4. Click OK.
The system exports the selected files to the connection export directory. If all files export
successfully, the system displays the Transaction Log File dialog box. If one or more files do not
export successfully, the system displays the log.
3. Click Refresh.
The system checks to see if the selected file has been modified in Teamcenter since the last
export to the connection. If the file has been modified in Teamcenter but has not been modified in
the connection, the system re-exports the selected file, its components, and its related files.
4. Click OK.
The system updates the connection directory with all changes made in Teamcenter since the
last export operation, including adding new components to the assembly, removing deleted
components from the assembly, exporting new item revisions, and exporting new dataset
revisions.
• Files that have not been modified in the connection export directory are skipped and not imported.
• Soft links in the connection export directory are not supported. Attempting to import soft links can
cause unpredictable results.
The system displays the File(s) to Import dialog box dialog box.
4. Select any files that you do not want to import and choose Skip in the Action column.
5. Click OK.
The system imports the files from the connection export directory. After the files have been
imported, the system displays the Transaction Log dialog box.
1. Select a connection in the Connection Name column of the Connections dialog box.
2. Select Yes in the Export Only column corresponding to the selected connection.
2. Select AIE from the tree on the left side of the Options dialog box.
The system displays the AIE options in the dialog box.
General tab
Save log from deleted connections Directs the system to save the transaction log file
for each connection after the connection is deleted.
The log file is saved in the top-level NX Remote
Manager connection directory. The name of the file is
the name of the connection followed by a number to
make it unique. For example, a connection named
UG-RM_001 has a corresponding transaction log file
named UG-RM_001_6671.log.
Export tab
Export Directory Allows you to define the top-level NX Remote Manager
connection directory. This is the main directory where
the system creates the export directory for each
connection.
Export read only files as read only Specifies how files associated with datasets to which
you do not have write permission are exported. If
this option is selected, those files are written in the
connection export directory with read-only privileges. If
not checked, all files are written to the export directory
with read/write privileges.
Named References to Export Specifies the named references to export to a
connection. Valid values are:
All
Exports all named references of the dataset.
Select
Displays a dialog box for selecting specific named
references to export.
Primary
Exports the primary named reference for the
dataset.
Check out new components during Specifies that all items that can be checked out are
refresh connection checked out when the connection is refreshed.
Import tab
File types to ignore Defines the file types to ignore during import, such as
backup files.
Import Details Master Indicates if the user has permissions to modify import
information in the XML files when importing them back
to Teamcenter. Valid values are:
Application
User is not allowed to change the import information
from Teamcenter.
Both
User is allowed to modify import information from
Teamcenter.
NX tab
Part Family Members Specifies how to process part family members during
import/export.
Autotranslate Mode Specifies whether autotranslate mode is the default
behavior or whether import should be legacy compatible.
The transaction log for the selected connection is displayed. The transaction log viewer allows
you to print the log file or save it as a text or HTML file.
• Exchange files
• High security
Exchange files
NX Remote Manager writes and reads XML exchange files in the connection export directory. An XML
file is written for each file that is exported. These files contain metadata such as product structure,
attribute information, and timestamp information. NX Remote Manager uses this information to
determine which files must be updated when a subsequent export or import operation is performed.
These XML files must reside in the connection export directory for the duration of the connection. If
the contents of the connection directory get moved or copied, the XML files must be moved or
copied along with the application files.
High security
NX Remote Manager exports files with read and write permissions. Those files that are not explicitly
checked out are exported as read-only reference files. On import, only files that have been checked
out can be reimported. This security behavior is referred to as high security and applies to all files
that are managed by a connection.
• Select the data to be exported, single items (My Teamcenter) or a BOM line (Structure Manager).
Note
Connections keep a history of the data sent to the connection and the data received
from the connection. You can have more than one connection open at any time. This
enables a single data manager to send data to multiple suppliers and keep track of
what has been sent to and received from each supplier.
Every connection has only one owner. The data manager that creates the remote
connection is the connection owner.
Note
The system does not validate whether the connection name is unique; however, you
must specify a unique connection name.
6. Select the dataset type to be exported from the Dataset Type list.
The list includes all registered NX Remote Manager dataset types that can be exported if found
in the assembly structure.
You can:
• Select a single dataset type to be exported.
After the dataset types are selected, the system displays the top BOM line.
8. (Optional) Apply one of the following export or checkout selections to single components:
• Skip (None of the boxes are checked.)
The selected datasets under the BOM line are not exported.
• Export+CO (Both the Export and Check Out boxes are checked.)
The selected datasets under the BOM line are exported and checked out.
Note
You can only check out datasets to which you have write access. In addition, if
you attempt to check out datasets that are currently checked out, the system
automatically changes the status from Export+CO to Export.
3. Click Export.
The system displays the Export Root(s) to Connection dialog box.
The checkout ID displays comments that are applied to all datasets selected for checkout, and
the existing connection is displayed (if applicable).
4. If you do not have an existing connection, check the Create New Connection box.
• Export
Files under this dataset are exported but not checked out (read-only copy).
• Export+CO
Files under this dataset are exported and checked out (read/write copy).
Note
You can only check out datasets to which you have write access. In addition, if
you attempt to check out datasets that are currently checked out, the system
automatically changes the status from Export+CO to Export.
• Files that have not been modified in the connection export directory are skipped and not imported.
3. If you have more than one remote connection running, select a connection from the table.
The system analyzes the files to be imported. If no files have been modified or created, the
system detects this and the import operation stops. The system displays the analysis results
in the Comments column of the File(s) to Import dialog box.
5. Apply import options to the individual files using the Action list. The following options are
available:
• Skip
Excludes the file from the import operation.
Note
Skip is the only option available if you do not have write access to the selected
dataset.
• Import–Implicit CO
Implicitly checks out the dataset if it was not checked out at export and imports it to
Teamcenter.
• Import–Overwrite
Imports the dataset and overwrites the existing dataset in Teamcenter.
• Import–Next Rev
Imports the dataset in to the next revision of the item and cancels checkout on the previous
revision of the item.
6. After selecting the files to skip, click OK to import the selected files or Cancel to stop the import
operation.
If you selected Retain checkout, the connection directory is updated with the new item
ID/revision and item type values.
Note
In the case of an NX dataset, this implies an internal call to ug_clone (export – dry
run + actual export).
NX Remote Manager imports the files from the connection’s export directory. After the files have
been imported, the import results display. For import errors from the ug_clone utility, refer to
the syslog file.
The list of item types displayed depends on the dataset type specified in the XML file for the new file
and the item types defined in the DMS (data model service) for the dataset type.
If files exist in subdirectories under the main connection directory, the subdirectory information
corresponding to the files is stored in Teamcenter using a relative path. Subsequent exports of this
file use the relative path information to place the file in a subdirectory under the (new) connection
directory.
If a file is found more than once in the connection directory structure, only the first occurrence is
imported and subsequent occurrences are ignored. This is captured in the transaction log file.
Note
Custom item types must be registered with NX Remote Manager before they can be used
with integrated applications. The following example registers custom item types for the NX
Remote Manager.
<Info Datasettype="ACADDWG">
<Create>
<!-- <Value>[<itemtype>:<iMANrelation>:<viewtype>]</Value> -->
<Value>Item:Specification:view</Value>
<Value>Document:Manifestation</Value>
<Value>Item:Manifestation:view</Value>
</Create>
…
<Info Datasettype="ACADDWG">
<Create>
<!-- <Value>[<itemtype>:<iMANrelation>:<viewtype>]</Value> -->
<Value>CORP_Tool:Specification:view</Value>
<Value>Document:Manifestation</Value>
<Value>CORP_Tool:Manifestation:view</Value>
</Create>
…
2. Open the AdditionalInfo.xml file located in the AcadMgr_DIR\Support directory in a text editor
and add the item types to the file. This file lists the item types that appear in the Boundary
dialog boxes.
The following example shows the AdditionalInfo.xml file.
<!--
Copyright (c) 2005 Unigraphics Solutions
Unpublished - All rights reserved
THIS PROGRAM IS AN UNPUBLISHED WORK FULLY PROTECTED BY THE UNITED STATES
COPYRIGHT LAWS AND IS CONSIDERED A TRADE SECRET BELONGING TO THE
COPYRIGHT HOLDER.
The Item Types that will appear in the Boundary Dialogs that can be
accessed from NX Remote Manager.
Update this file if new Item types, which are known to Teamcenter
Engineering, need to be supported by the Boundary Dialogs
This is the GM Overlay version of this file.
28-Jun-2005 aputhenp Initial creation
28-Jun-2005 aputhenp The first line has to be ?xml....
$HISTORY$
-->
<BoundaryTypes>
<Type>MEStation</Type>
<Type>MEWorkarea</Type>
<Type>MELine</Type>
<Type>MEDepartment</Type>
<Type>MESite</Type>
<Type>MEPlant</Type>
<Type>CORP_Facility</Type>
<Type>CORP_Tool</Type>
<Type>CORP_Part</Type>
<Type>CORP_Vehicle</Type>
<Type>CORP_Criteria</Type>
<Type>CORP_Proc_Plan</Type>
<Type>CORP_Simulation</Type>
<Type>CORP_Analysis</Type>
<Type>CORP_Process</Type>
<Type>CORP_Equipment</Type>
<Type>CORP_Install</Type>
</BoundaryTypes>
3. After modifying the XML files, open an MS-DOS window in the Teamcenter environment, and
enter the following command on a single line:
aie_install_datamodel_objs -u=user-name
-p=password -g=dba —file=acaddwg_dms.xml -modify=yes
Note
When modifying the XML files, consider the following guidelines:
• Do not modify the xName element of the existing xRelation. You can add new
XRelation elements, but they must be constant between versions of XML.
4. If you do not have access to the XML files used to initially install the data model objects, run the
following program to delete existing instances of the dataset types:
aie_clean_datamodel_objs -dstype=all
Note
You can selectively delete instances corresponding to a particular dataset type by
specifying a dataset type name for the -dstype= argument.
5. After deleting the dataset type instances by running the aie_clean_datamodel_objs utility,
run the aie_install_datamodel_objs utility without the -modify argument to populate the data
model instances.
Preferences
Preferences are used to configure NX Remote Manager. Preferences are environment variables
stored in the database and are read when a Teamcenter session or a session of an integrated
application is initiated. For more information about preferences, see the Preferences and Environment
Variables Reference.
AIE_EM_installed
DESCRIPTION
Specifies whether or not a site has AIE (Application Integration Environment)
Encapsulation Manager installed.
VALID
VALUES
YES AIE Encapsulation Manager is installed.
NO AIE Encapsulation Manager is not installed.
DEFAULT
VALUE
NO
DEFAULT
PROTECTION
SCOPE
Site preference.
AIE_installed
DESCRIPTION
Indicates whether or not a site has AIE (Application Integration Environment) installed.
VALID
VALUES
YES AIE (Application Integration Environment) is installed.
NO AIE (Application Integration Environment) is not installed.
DEFAULT
VALUE
NO
DEFAULT
PROTECTION
SCOPE
Site preference.
AIE_named_refs_to_export
DESCRIPTION
Allows you to specify the named references to export to a connection.
VALID
VALUES
all Exports all named references of the dataset.
select Displays a dialog box allowing you to select the named references to
export.
primary Exports the primary named reference of the dataset.
DEFAULT
VALUE
primary
DEFAULT
PROTECTION
SCOPE
Site preference.
AIE_overwrite_default_import_item_types
DESCRIPTION
Controls whether the default item types can be overwritten during import using NX
Remote Manager.
VALID
VALUES
on Allows the user to choose from all item types listed in the DMS when
importing new or previously exported files.
off Disables item type selection when importing files. Files that were
previously exported from Engineering Process Management are imported
using the item type assigned when they were exported, and new files are
imported using the default item type.
DEFAULT
VALUE
on
DEFAULT
PROTECTION
SCOPE
Site preference.
AIE_skip_class_types_for_save
DESCRIPTION
Specifies item types that must not be displayed as options in the Item Type list in the
Save dialog box when saving a file in an integrated application. For example, business
rules in the GM Overlay prevent items of type Item from being created. Adding Item
as a value for this preference prevents the item type from being a choice when items
are saved in NX Remote Manager.
VALID
VALUES
Any valid item type for which creation is disallowed.
DEFAULT
VALUE
This preference is unset in the Engineering Process Management environment. In the
Teamcenter Automotive Edition–GM Overlay environment, the default value is Item.
DEFAULT
PROTECTION
SCOPE
Site preference.
AIE_POST_EXPORT_SCRIPT
DESCRIPTION
Specifies a fully qualified path to an executable script that are executed after the
completion of NX Remote Manager export operation.
VALID
VALUES
Path to the script. This path must not contain special characters or spaces. In addition,
the path separator must be in accordance with the platform on which the script runs,
for example:
UNIX systems:
AIE_POST_EXPORT_SCRIPT=/usr/bin/my_export.sh
Windows systems:
AIE_POST_EXPORT_SCRIPT=C:\Utilities\my_export.bat
DEFAULT
VALUE
By default, this preference is not set.
DEFAULT
PROTECTION
SCOPE
Site preference.
AIE_PRE_IMPORT_SCRIPT
DESCRIPTION
Specifies a fully qualified path to an executable script that will be executed before the
NX Remote Manager import operation begins.
VALID
VALUES
Path to the script.
DEFAULT
VALUE
By default, this preference is not set.
DEFAULT
PROTECTION
SCOPE
Site preference.
Utilities
Command line utilities are used to install and maintain the NX Remote Manager data model and to
import files in batch mode. For more information about utilities, see the Utilities Reference.
aie_clean_datamodel_objs
DESCRIPTION
Deletes instances of a specific dataset type or instances of all dataset types from the
NX Remote Manager data model.
SYNTAX
aie_clean_datamodel_objs -u=user-id -p=password -g=group
-dstype=all | datasettype-name
ARGUMENTS
-dstype Specifies the dataset type for which instances will be deleted.
ENVIRONMENT
As specified in Configuring utilities.
FILES
As specified in Log files.
RESTRICTIONS
None.
EXAMPLES
• The following example unregisters all dataset types that are registered in the NX
Remote Manager data model:
aie_clean_datamodel_objs -u=infodba -p=password -g=dba
-dstype=all
• The following example unregisters the NX Remote Manager data model for the
UGMASTER dataset type:
aie_clean_datamodel_objs -u=infodba -p=password -g=dba
-dstype=UGMASTER
aie_install_datamodel_objs
DESCRIPTION
Adds, modifies, and deletes data model definitions based on customer-defined item
types.
SYNTAX
aie_install_datamodel_objs -u=user-id -p=password -g=group
-file=dms_definition_file [-modify=yes]
ARGUMENTS
-file Specifies the name of the file containing the NX Remote Manager
data model definition. The NX Remote Manager data model file is
written using XML syntax, which must follow the document type
definition in the dms.dtd file.
-modify Specifies whether the NX Remote Manager data model is
overwritten. The value yes overwrites the data model.
ENVIRONMENT
As specified in Configuring utilities.
FILES
As specified in Log files and the aie_install_datamodel_objs183e5050.log and
aie_install_datamodel_objs183e5050.jnl files.
RESTRICTIONS
The -modify argument must only be used with the value yes. If the
aie_clean_datamodel utility was previously run for the same dataset type, you do not
need to specify the -modify argument.
EXAMPLES
The following example registers the UGMASTER dataset with NX Remote Manager by
providing an NX Remote Manager data model definition for the dataset type:
aie_install_datamodel_objs -u=infodba -password=password -g=dba
-file=ugmaster_dms.xml -modify=yes
BatchImp
DESCRIPTION
Imports multiple files in to the Teamcenter database without starting the integrated
CAD application.
SYNTAX
BatchImp [-r] [-q] [-n] input-file-name -u=user-id -p=password -g=group
[-f=Teamcenter folder] [-n ] [-x] [-xml] [-d=dataset-type] [-dryrun]
ARGUMENTS
input file Specifies the input map file containing the list of drawings with item
ID, item type, and specified attributes.
-r Specifies that if the drawing was previously imported in to
Teamcenter, it should be imported under a new item revision. This
argument is optional.
-q Specifies whether the user should be prompted for each previously
imported drawing to be reimported. If the drawing is to be imported
as specified by the user, the -r option is used to determine whether
a new item revision is created. This argument is optional.
-n Specifies that only those drawings that have not previously been
imported in to Teamcenter are imported. This argument is optional.
-x Specifies that the batch import only creates the according IXF files
and uses the aie_batch_import.exe utility to perform the import
operation. If this argument is not specified, the batch import .arx file
performs the import without creating the .ixf files.
-xml Generates the IXF file for a specific drawing.
This option does not import the drawing files in to the Teamcenter
database. It is intended to create the IXF files that are required
when importing drawings in NX Remote Manager mode.
-u Specifies the user ID used to log in to the Teamcenter database.
This argument is required unless single sign-on (SSO) in Security
Services is enabled. If SSO is enabled, this argument is not
necessary and is ignored if provided.
-p Specifies the password used to log in to the Teamcenter database.
This argument is required unless single sign-on (SSO) in Security
Services is enabled. If SSO is enabled, this argument is not
necessary and is ignored if provided.
-g Specifies the group of the user logging in to the Teamcenter
database. This argument is required.
-f Specifies the Teamcenter folder in which items or item revisions
are created for the imported files. If not specified, the default is the
Newstuff folder. This argument is optional.
-d Specifies the dataset type of the Teamcenter dataset object to which
the imported files are attached.
-dryrun Specifies a dry run that generates a new output file named by
appending _dryrun to the original input map file name. For each
drawing file specified in the input map file, the dryrun option
traverses the drawing and transcribes the original input line along
with the file names of every component file, if inputting an assembly,
to the output file in bottom-up fashion. The output file gives the
user a clear view of the files involved in the import operation. The
output file also serves as a new input map file to the batch import
program. When the dryrun option is specified, only the input map
file must be specified.
ENVIRONMENT
This utility must be run from the command line in an MS-DOS shell with all Teamcenter
environment variables set appropriately.
FILES
None.
RESTRICTIONS
None.
NOTES
• All drawings imported to Teamcenter without using the -x option have the item ID
and item revision stored as attributes in the Teamcenter data directory.
• If the batch import finds the attributes for item ID and item revision in the
Teamcenter data dictionary and values are assigned to them, the file is imported
by default unless the -n argument is used.
• If the -r argument is not used, the drawing is imported in to the existing item
revision.
• When specifying attribute names for general attribute batch import, names must
reflect the Teamcenter attribute name rather than the CAD application attribute
name.
• Errors appear in the batch import log file when importing multilevel assemblies.
• During batch import, BOM view revisions are not updated when an assembly is
reimported in to the current item revision. After importing the assembly using the
batch import utility, create the BOM view revision in the two-tier rich client by
sending the parent component to Structure Manager, adding the child items in
Structure Manager, and saving the structure.
EXAMPLES
In this example, the user imports two drawings, as follows:
test_batch_1.dwg
\
test_batch_3.dwg
test_batch_2.dwg
The first line in the file is mandatory. The entries Attributes, itemID, and itemtype
are required. The MachNum entry represents the name of an attribute to be input
during import.
The first entry in the second line of the file specifies the full path to the drawing being
imported. The other entries in this line are the item ID, item type, and the value of
the MachNum attribute.
The fourth line contains entries for the item ID and type. These can be left blank, in
which case the item ID are generated automatically, and the item type defaults to Item.
Warning
This file must be edited using a text editor, such as Notepad. In addition, the
file must end with a new-line character.
connection name
Automatically generated or user-provided name that identifies the connection between Teamcenter
and Teamcenter Integration for AutoCAD.
NX Remote Manager
Teamcenter component for managing the import and export of documents into Teamcenter. NX
Remote Manager is a common component across integrations that include applications in fields
such as CAE and ME.
Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000
Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499