Provides an identification for physical or conceptual entities about which an organization maintains information and audit/control change. Items are the fundamental objects used to manage information. Typical uses of items are parts, documents and equipment. In engineering and product development environments, parts are identified as items.
• Attributes item_id
A unique character string which by the item is identified.
configuration_object_tag
The tag that points to the configuration object.
bom_view_tag
The tag that points to the BOM View.
uom_tag
The tag that points to the unit of measure.
• Specializations create
Creates the item and the first item revision. This method also creates an item master form for the item and the item revision. These forms have a Master_form relation to the item and item revision.
delete
Deletes an item, its item master, and any relations to other objects. It also deletes all item revisions of the item.
Item Revision
Reflects modifications to an item. Once an item revision has been released, a new item revision can be created. The original item revisions are retained for historical purposes. Customer sites define their own procedures to determine how and when a new item revision should be created.
• Attributes
item_revision_id
A unique character string by which the item revision is identified.
items_tag
The tag that references the parent item.
structure_revision
The number of times the structure has been revised
• Specializations find
Returns the item revision with a given item_revision_id and parent
Chapter 6 Core Functions
copy
Creates a copy of the original item revision inside the same item.
create
Creates an item revision and an item master form. The item master form has a Master_form relation to the item revision.
delete
Deletes the item revision, its item master, and any relations to other objects.
Dataset
Encapsulates the actual structure of a package of application data and associates that package with a list of tools.
• Attributes
dataset_type
The tag of the DatasetType object that this dataset is a type of.
tool_used
The tag of the tool that created the particular dataset revision.
format_used
The format of the dataset.
user_class
A string attribute that enables you to further classify your datasets.
rev_chain_anchor
The tag of the revision anchor that associates the dataset with its previous and subsequent revisions.
named_references
A list of references to objects that contain the actual application data. This is presented through the interface as sets of three values:
– An object reference.
– A reference name.
– A reference type.
These are actually stored as three separate lists, ref_list, ref_names and ref_types, which are kept in sync by Teamcenter.
Core Functions
• Methods revise
Similar to the copy method, except the copy is considered a new revision of the original dataset.
delete_all_revisions
Deletes all revisions of a dataset.
purge
Removes all old, non-referenced revisions except the latest.
• Specializations revision_limit
A dataset object actually sets and asks the revision limit by using the keep limit of its revision anchor.
copy
In addition to copying the dataset, this method also copies the revision anchor. The new dataset becomes revision 1.
latest
Asks the revision anchor for the latest revision.
getInfo
Adds the dataset type name, tool name, site classification, and format to the list of values returned by the getInfo method.
delete
Deletes the dataset and revision anchor if there are no other revisions and the objects pointed to by the named references, they are the AE_PART_OF type, and not referenced by another object or loaded in another session.
refresh
Refreshes the dataset and the revision anchor.
Chapter 6 Core Functions
Tool
Represents an external application in Teamcenter. The tool must also contain information about how to run the application and what kinds of input formats, output formats, and parameters the application understands.
• Attributes
symbol_name
The command used to run the application.
site_classification
A text string that enables the user to classify tools.
shell_or_translator
A flag that indicates whether a tool is a normal application, a shell used to communicate with an application, or a translator used to convert data from one format to another.
encapsulator
The tag of the tool (shell) used to communicate between Teamcenter and this tool.
input_formats
A list of formats this tool can understand as input.
output_formats
A list of formats that this tool can output.
variables
A list of names of input parameters that this tool can accept.
default_values
The default values of the above variables.
vendor_name
The name of the vendor that supplied the actual application.
version
The version of the application.
install_date
The date that the application was installed.
Core Functions
Form
Provides the customer with a collection of name/value pairs with enough information to display a form window that can show and allow modification of the values.
• Attributes form_file
The name of a compiled UIL file that contains the attribute names and the layout of the form that Teamcenter uses for presenting it in the user interface for display and modification.
data_file
The tag of the POM object that actually contains the name/value pairs. This could be an ImanFile object or a POM class defined by the customer.
• Methods ask_value
Returns the value of a particular attribute.
set_value
Sets an attribute value.
• Specializations getInfo
Returns the workspace object values and the name of the form definition file.
delete, refresh, unload, and save
These methods act on the POM object or ImanFile object associated with the form, as well as the form itself.
Chapter 6 Core Functions
DistributionList
Contains the list of users, groups, and distribution lists that a particular type of mail should go to.
• Attributes
listOfMembers
List of users, groups, and distribution lists.
Status
Represents an engineering task and the authorization process for that task.
• Methods find
Finds a status with a given name.
Signoff
Associates an approval or authorization status with a group member.
• Attributes
group_member
The group member who is to decide to authorize or not.
decision
The decision. It must be YES, NO, or NO_DECISION.
decision_date
The date on which the decision was made.
comments
A string to contain any additional comments about the signoff. This is not the same as the task comment.
Role
Describes a role that a user can play in a group.
• Attributes role_name
The unique name of the role.
description
A description of the role.
Core Functions
Person
Represents an actual human being in the Teamcenter system. The person profile can be customized by changing the selectedpersonwindowintl.uih and selectedpersonwindowlocal.uih in the IMAN_LANGUAGE directory.
The following is the description of the person object model and how its attributes are being mapped from the user interactive interface:
User Interactive Interface Object Model Description
Person name User name: the full name used to identify a person.
All of the attributes, form name, and pa1 through pa10 are optional attributes that can store up to 32 characters.
• Attributes first_name
First name of the person.
middle_name
Middle name of the person.
last_name
Last name of the person.
street_address
The person’s street address.
city
The city where the person lives.
state
The state where the person lives.
zipcode
The person’s zip or mail code.
organization
Chapter 6 Core Functions
phone_number
The person’s phone number.
date_of_birth
The person’s birthday.
• Methods find
Finds a person with the given first name, last name, middle name, and date of birth.
Core Functions
ImanVolume
Represents a physical storage location for files in the operating system in the Teamcenter database.
• Attributes
volume_name
The unique name of the volume.
unix_path_name
The path name of the volume in UNIX format.
wnt_path_name
The path name of the volume in Windows format.
node_name
The name of the machine that the volume (directory) is on.
users
The list of users and groups that have access to this volume.
protection_mode Not currently used.
machine_type
The type of machine that the volume’s directory resides on.
• Methods
find_by_name
Finds the volume with the given name.
find_by_path
Finds the volume with the given pathname.
grant_access
Gives a user or group access to a volume.
revoke_access
Removes write access to a volume for a user.
check_access
Determines if a particular user has write access to a particular volume.
Chapter 6 Core Functions
ImanFile
Represents an operating system file in the Teamcenter database.
• Attributes file_name
The leaf name of the file in the Teamcenter volume.
original_file_name
The name the file is given if it is exported to the operating system by the IMF_export_file function.
sd_path_name
The pathname to the operating system file. This is in a system-dependent format.
translate
Indicates whether the file is stored in Teamcenter machine-translatable format.
text_flag
Indicates whether the file is text or binary.
machine_type
Indicates what machine format the file is in.
volume_tag
The tag of the volume on which the operating system file resides.
status_flag
Indicates if the file is scheduled to be deleted.
time_last_modified
The time stamp on the file indicating when it was last changed by Teamcenter.
released_version Reserved for future use.
Core Functions
• Methods open
Opens the operating system file associated with the ImanFile database object.
close
Closes the operating system file associated with the ImanFile database object.
read
Reads binary data or lines of text from a file.
write
Writes binary data or lines of text to a file.
import
Brings an existing operating system file under control of Teamcenter as an ImanFile database object.
export
Copies an ImanFile database object into a specified operating system directory, thus relinquishing Teamcenter control over the file.
Chapter 6 Core Functions
DatasetType
Represents a named list of tools that can operate on a particular type of dataset.
• Attributes
datasettype_name
The unique name of the DatasetType instance.
description
A description of the type of data that this object represents.
parent_type
The tag of a DatasetType class that this instance is a kind of. Enables the user to classify dataset types.
list_of_tools
The tags of all of the tools that can operate on datasets of this type.
action_list
The list of workspace actions (open, destroy, purge, and so on) for which this type of dataset has specialized behavior. The default tool is run if the particular action chosen is in this list. If not, the action has the default Teamcenter behavior.
named_ref_list
The list of all of the possible named references that datasets of this type may have.
• Methods
default_tool
Return the default tool for the dataset type. This is the first in the list.
find
Return the tag of the dataset type with a given name.
Core Functions
RevisionAnchor
Provides facilities for collecting an ordered set of related objects. Normally these would be successive revisions of an object. It is used only for datasets.
• Attributes revisions
A list of the revisions.
keep_limit
Indicates how many revisions to keep before attempting to delete the older ones.
highest_rev
Indicates the highest revision ever achieved in the life of this revision anchor.
• Methods latest
Returns the most recently created object in the set of revisions.
make_room
Removes a number of objects from the set of revisions.
purge
Removes all objects from the set of revisions, except the latest.
Chapter 6 Core Functions
ItemMaster
Represents a form that has a Master_form relation with an item and item revision.
This class can be specialized at each site, and Teamcenter comes with some standard attributes.
Form objects can store data in two different ways. In the system as delivered, item master and item revision master data is stored in ImanFiles. The ItemMaster class is provided if you prefer to store the data in POM. To store it in POM, you need to modify the itemmaster.uil and itemversionmaster.uil files by changing the POMClassName entries to ItemMaster.
• Attributes project_id
The identification of the project under which the item was developed.
previous_item_id
The item that is being superseded by this one.
serial_number
A number assigned to the item by your organization.
item_comment
Comments made by the engineer.
user_data_1/2/3
Fields where the user can place data.
Core Functions