The Open C API interface to NX Manager. This file describes the set of extra Open
API calls that are provided for use with NX Manager. These calls are not
available when using NX without NX Manager.
The functions fall into the following categories:
. Encoding and decoding part file names
. Invoking Team Center Engineering ITK functions
. Managing associated files
. Controlling default actions
. Navigating the database
NOTE: The following is a related NX Manager function that is
described in uf.h file:
.
UF_is_ugmanager_active this routine checks to see if an NX Manager process is active.
Data Model
Writing Open API Programs
File Name Formats
Invoking Team Center Engineering ITK functions:
----------------------------
The Open API
UF_UGMGR_invoke_pdm_server enables you to make calls to (and receive output from) Team Center Engineering ITK functions
Controlling Default Actions:
----------------------------
A number of NX Manager Open APIs are provided that allow
you to control the default action of NX Manager when it creates
parts. For example, you can place all your newly created parts in a
default folder using the function UF_UGMGR_set_default_folder.
The functions for enquiring and setting default actions are:
UF_UGMGR_set_config_rule UF_UGMGR_set_default_folder UF_UGMGR_list_config_rules UF_UGMGR_ask_config_rule Associated files (e.g., shaded image files, Manufacturing-related files)
that belong to a part file can be managed through the NX Manager Open API.
The functions used to manage associated files are:
UF_UGMGR_ask_dependent_files UF_UGMGR_ask_export_directory UF_UGMGR_ask_folder_name UF_UGMGR_ask_user_role UF_UGMGR_set_file_export_status UF_UGMGR_ask_file_export_status UF_UGMGR_set_user_role A group of functions is provided to enable an Open API program to navigate
the folder structure in the Team Center Engineering database.
A folder may contain other folders and parts. A part contains part revisions.
Folders, parts, and part revisions are known as database objects. Each object
that exists in the Team Center Engineering database is given an NX Manager database tag, a typed
tag UF_UGMGR_tag_t. This database tag is different from the normal NX
tag, the typed tag tag_t.
Note that when using the functions provided to navigate the database, in most
cases you pass to the function an NX Manager database tag UF_UGMGR_tag_t, not a
NX tag_t.
NOTE: If you pass a tag of type tag_t instead of a database tag UF_UGMGR_tag_t
to an NX Manager Open API, the function does not recognize the tag and
returns an error code.
Open APIs that can be used to navigate the Team Center Engineering database are given below:
UF_UGMGR_ask_root_folder UF_UGMGR_list_folder_contents UF_UGMGR_ask_object_type UF_UGMGR_ask_folder_name UF_UGMGR_ask_part_tag UF_UGMGR_ask_part_number UF_UGMGR_list_part_revisions UF_UGMGR_ask_part_revision_id UF_UGMGR_list_part_rev_files UF_UGMGR_ask_part_name_desc UF_UGMGR_partrev_where_used