mt00324 Ems

Teamcenter 9.
0
Teamcenter Enterprise
EMS Module
Application Programmer’s Interface

Reference
Publication Number
MT00324 L1
Teamcenter 9.0
Teamcenter Enterprise
EMS Module
Application Programmer’s Interface

Reference
This product is intended for use only as described in this document.

Siemens PLM Software cannot be responsible for the proper functioning
of undescribed features and parameters.
Publication Number
MT00324 L1
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 5
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 6
Submitting Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Proprietary and Restricted Rights Notice . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Part I: Messages and Methods
EMS Messages and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

External Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Internal Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1
MT00324 L1 API Reference 3

Preface
This manual describes the Integrator Toolkit Application Programming Interface

(API) provided with Teamcenter Enterprise. Integrator Toolkit belongs to the
Siemens PLM Software portfolio of digital product lifecycle management software
and services.
Audience
This manual contains information for developers, customizers, and localizers. It
assumes that readers understand the basic concepts of object-oriented user interface
design and programming, such as the principles of object classes, hierarchies, and
inheritance. It also assumes that readers understand the concepts described in the
Integrator Toolkit Customization manual.
Knowledge of the C language is also assumed.
Whenever a function is called or another message is sent, the status return
(dstat) must be checked. dstat error conditions are fatal (unrecoverable), so
when a method encounters a dstat error condition, it must immediately exit
the method. The uiShowFatalError function displays a helpful diagnostic
message (called a traceback) as the method. There are some convenience
macros that can be used in place of uiShowFatalError to give more specific
diagnostics and to set the correct dstat value. For more information, see
the Server Customization manual.

Preface
Conventions
This manual uses the conventions described in the following sections:
Revision Marks
Technical changes are marked by a bar adjacent to the changed text.
Note, Caution, and Warning Icons

The following icons represent note, caution, and warning messages:
A note icon identifies general instructions or comments that need to be
emphasized.
A caution icon identifies practices that can either produce results contrary to
what you expect or result in damage to software or data.
A warning icon identifies practices that could result in permanent loss of

data or software.
Names and Values

This manual represents system names, file names, and values in fonts that help you
interpret the name or value. For example:
Change or add the parameter to the initsid.ora file.
The conventions are:
Bold Bold font represents unvarying text or numbers within a name or

value. Capitalization is as it appears.
Italic Italic font represents text or numbers that vary within a name or
value. The characters in italic text describe the entry. Letters are
shown in lowercase, but the varying text may include uppercase
letters.
In initsid.ora, sid identifies a varying portion of the name (a
unique system ID). For example, the name of the file might be:
initBlue5.ora
text-text A hyphen separates two words that describe a single entry.
6 API Reference MT00324 L1

Preface
Command Line Entries, File Contents, and Code

This manual represents command line input and output, the contents of system files,
and computer code in fonts that help you understand how to enter text or to interpret
displayed text. For example, the following line represents a command entry:
msqlora -u system/system-password
Monospace Monospace font represents text or numbers you enter on a

command line, the computer’s response, the contents of system
files, and computer code.
Capitalization and spacing are shown exactly as you must enter
the characters or as the computer displays the characters.
Italic Italic font represents text or numbers that vary. The words in
italic text describe the entry.
The words are shown in lowercase letters, but the varying text
may include uppercase letters. When entering text, use the case
required by the system.
For the preceding example, you might substitute the following for
system-password:
KLH3b
text-text A hyphen separates two words that describe a single entry.

Preface
Syntax Definitions
This manual uses a set of conventions to define the syntax of Teamcenter Enterprise
language statements, commands, and functions. Following is a sample syntax
format for a MODeL statement:
define value set value-set-name {’[’value [, value ...] ’]’ | date}
Bold Bold text represents keywords. Enter keywords as shown, in either

all uppercase or all lowercase characters—do not mix uppercase and
lowercase letters. In the define value set statement, the following
words are keywords:
define value set
Italic Italic text represents values that you supply.
| A vertical bar represents a choice between mutually exclusive
elements. In the define value set statement, you can enter either
value or date.
[] Brackets represent optional elements. In the define value set
statement, you are not required to enter the following element:
[, value ...]
{text} Braces surround mutually exclusive elements that are required. In
the define value set statement, you must enter either value or date.
’[’ Single quotation marks enclose a bracket when it represents a
character that you enter rather than the symbol for optional
elements. In the define value set statement, one pair of brackets is
enclosed in single quotation marks:
’[’value [, value...] ’]’
These brackets do not represent an optional element. You must
enter the brackets.
... An ellipsis indicates that you can repeat the preceding element.
In the define value set statement, you can repeat the following
element:
[, value ...]
text-text A hyphen separates two words that describe a single value. In the
define value set statement, the following words represent a single
value:
value-set-name
You enter the name of a value set.

Preface
Submitting Comments
Portions of Teamcenter software are provided by third-party vendors. Special
agreements with these vendors require Siemens PLM Software to handle all problem
reports concerning the software they provide. Please submit all comments directly to
Siemens PLM Software.
Please feel free to give us your opinion of the usability of this manual, to suggest
specific improvements, and to report errors. Mail your comments to:
Siemens PLM Software Technical Communications
5939 Rice Creek Parkway
Shoreview, MN 55126
U.S.A.
To submit an incident report, you can use the Siemens PLM Software GTAC online
support tools at the following URL:
http://support.industrysoftware.automation.siemens.com/gtac.shtml
Proprietary and Restricted Rights Notice

This software and related documentation are proprietary to Siemens Product
Lifecycle Management Software Inc.
© 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
All trademarks belong to their respective holders.

Part
I Messages and Methods
EMS Messages and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
MT00324 L1 API Reference

Chapter
1 EMS Messages and Methods
External Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

External Trusted Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
CheckReplicaSyncStatusD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
PdmItemEms:CheckReplicaSyncStatusD . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
ExportObjectSetDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
PdmItemEms:ExportObjectSetDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
PdmRoot:ExportObjectSetDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
InflateDisplayedIcons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
OwnedItmEms:InflateDisplayedIcons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
PartEms:InflateDisplayedIcons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
PdmItemEms:InflateDisplayedIcons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
InflateDisplayedName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
TransOpt:InflateDisplayedName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
ProcessDialgForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
DAttachToSwitch:ProcessDialgForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
DRExport:ProcessDialgForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
SetDialogDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
DClosRuleCre:SetDialogDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
DGMSCfgCre:SetDialogDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
DGMSCfgGetI:SetDialogDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
DGMSCfgUpd:SetDialogDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
DODSSiteCre:SetDialogDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
DODSSiteGetI:SetDialogDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
DODSSiteUpd:SetDialogDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
DSiteCre:SetDialogDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
DSwitchQry:SetDialogDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
DTransOptDesc:SetDialogDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
ValidateDialgForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
DAttachToSwitch:ValidateDialgForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
DExportTB:ValidateDialgForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
DExportTC:ValidateDialgForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
DImportTB:ValidateDialgForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
DImportTC:ValidateDialgForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
DRExport:ValidateDialgForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
DClosRuleCre:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
DClosRuleUpd:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
DGMSCfgCre:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
DGMSCfgUpd:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
DImportTB:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
DImportTC:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
DODSSiteCre:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
DRemotesrchSearch:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9

DSiteCre:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
DSiteUpd:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
DSwitchCre:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
DSwitchQry:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
DTransOptSetCre:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
DTransOptSetQry:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
DTransOptSetUpd:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
DTransTrkUpd:ValidateDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Internal Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12

AttributeToIgnore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
BulkDeletePre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
CreateReqObjectPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13
TcEntReq:CreateReqObjectPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
CreateReqObjectPre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
TcEntReq:CreateReqObjectPre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
CreateRequestPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
CreateRequestPre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16
DeleteDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
ExRecRel:DeleteDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
ImpRec:DeleteDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
RelationEms:DeleteDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
RelImpRc:DeleteDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
DeleteReqObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
DeleteReqObjectPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19
DeleteReqObjectPre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19
DoCopyAtOs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21
FSItemEms:DoCopyAtOs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21
DoCreateRelPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22
TmToCRC:DoCreateRelPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22
DoDeleteAuxForRel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-23
RelImpRc:DoDeleteAuxForRel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-23
DoDeleteRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
TmToCRC:DoDeleteRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
DoesRelClassValForDel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-25
TmToCRC:DoesRelClassValForDel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-25
DoesRelSideValForDel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-26
TmToCRC:DoesRelSideValForDel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-26
DoObjDelAuxForRel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-27
ExRecRel:DoObjDelAuxForRel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-27
RelationEms:DoObjDelAuxForRel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-27
RelImpRc:DoObjDelAuxForRel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-27
ExportObjectToXMLPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-27
PdmRoot:ExportObjectToXMLPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
ExpSetGetRelationCtxt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-29
FilterOtherSideObjAndRel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-29
PdmItemEms:FilterOtherSideObjAndRel . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
FindEquivalentLocalObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31
OwnedItmEms:FindEquivalentLocalObject . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31
PdmItemEms:FindEquivalentLocalObject . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31
PdmRoot:FindEquivalentLocalObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31
RelationEms:FindEquivalentLocalObject . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31
Stub:FindEquivalentLocalObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31
FindLocalObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31
API Reference MT00324 L1

OwnedItmEms:FindLocalObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
PdmItemEms:FindLocalObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
PdmRoot:FindLocalObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
RelationEms:FindLocalObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
GatherClassesToExportPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
PdmRoot:GatherClassesToExportPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-33
GenerateMessageID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-33
TransTrk:GenerateMessageID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-33
GetCheckInMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
GetClientID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
MultiSite:GetClientID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
GetClientIDfromTrnFormula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
TransferFormula:GetClientIDfromTrnFormula . . . . . . . . . . . . . . . . . . . . . . . 1-35
GetCustomOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
TransOpt:GetCustomOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36
GetMergedObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36
GetMultipleRootObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36
GenDoc:GetMultipleRootObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
ItemMstr:GetMultipleRootObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
PdmItemEms:GetMultipleRootObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
StrucBI:GetMultipleRootObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
GetObjectsInSeriesForOwnTransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
WrkImEms:GetObjectsInSeriesForOwnTransfer . . . . . . . . . . . . . . . . . . . . . . 1-38
GetOdrForImportAux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-38
FSItemEms:GetOdrForImportAux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-39
GetOwnerForImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-39
OwnedItmEms:GetOwnerForImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-39
GetPredForOwnershipTransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-40
GetRootObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-40
PdmItemEms:GetRootObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-41
GetTeamFolderForObj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-41
BinFile:GetTeamFolderForObj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-42
GnDocDmm:GetTeamFolderForObj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-42
JT:GetTeamFolderForObj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-42
WrkImEms:GetTeamFolderForObj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-42
ImportFromXMLToDbPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-43
PdmRoot:ImportFromXMLToDbPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-43
ImportFromXMLToDbPre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-44
PdmRoot:ImportFromXMLToDbPre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-44
VewDepR:ImportFromXMLToDbPre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-44
InflateDynamicAttrExportPre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-44
InflateRequiredDynamicAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-44
WrkImEms:InflateRequiredDynamicAttributes . . . . . . . . . . . . . . . . . . . . . . . 1-45
InsertDbItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-46
OwnedItmEms:InsertDbItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-46
PdmItemEms:InsertDbItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-46
InsertDbRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-47
RelationEms:InsertDbRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-47
IsOTAllowedForImmutable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-47
WrkImEms:IsOTAllowedForImmutable . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-47
MoveDbItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48
OwnedItmEms:MoveDbItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48
PdmItemEms:MoveDbItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48
NotifyObjectOwnershipTransferred . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48

PdmRoot:NotifyObjectOwnershipTransferred . . . . . . . . . . . . . . . . . . . . . . . . 1-48
PropagateOccurrences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-49
RefreshDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-50
OwnedItmEms:RefreshDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-50
PdmItemEms:RefreshDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-50
RelationEms:RefreshDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-50
SetDefaultValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-50
PdmRoot:SetDefaultValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-51
SetDialgDefaultsForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-52
DImportTB:SetDialgDefaultsForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-52
DImportTC:SetDialgDefaultsForSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-52
DRemotesrchPublish:SetDialgDefaultsForSet . . . . . . . . . . . . . . . . . . . . . . . . 1-52
DRemotesrchUnpublish:SetDialgDefaultsForSet . . . . . . . . . . . . . . . . . . . . . . 1-52
SetImportAttrsAux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-52
FSItemEms:SetImportAttrsAux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-53
OwnedItmEms:SetImportAttrsAux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-53
PdmRoot:SetImportAttrsAux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-53
SetRelationDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-54
TmToCRC:SetRelationDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-54
SetSessionOptValueInFormula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-54
TransferFormula:SetSessionOptValueInFormula . . . . . . . . . . . . . . . . . . . . . . 1-54
SubmitExportRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-55
Exporter:SubmitExportRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-55
SubmitRequestToGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-55
UpdateDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-57
OwnedItmEms:UpdateDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-57
PdmItemEms:UpdateDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-57
RelationEms:UpdateDbObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-57
UpdateObjForExportPre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-57
PdmRoot:UpdateObjForExportPre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-58
ValForUnregister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-59
ValidateExportDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-59
DRExport:ValidateExportDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-59
ValidateForCheckIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-60
WrkImEms:ValidateForCheckIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-60
ValidateForCheckOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-61
WrkImEms:ValidateForCheckOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-61
ValidateForCkiToTeam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-62
WrkImEms:ValidateForCkiToTeam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-62
ValidateForCkoFromTeam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-63
WrkImEms:ValidateForCkoFromTeam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-63
ValidateForCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-64
WrkImEms:ValidateForCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-64
ValidateForCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-65
GMSCfg:ValidateForCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-65
ValidateForCreateRel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-66
RelationEms:ValidateForCreateRel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-66
StructurEms:ValidateForCreateRel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-66
ValidateForDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-67
GMSCfg:ValidateForDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-67
PdmItemEms:ValidateForDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-67
Switch:ValidateForDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-67
TransTrk:ValidateForDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-67
WrkImEms:ValidateForDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-67
API Reference MT00324 L1

ValidateForRelease . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-68
WrkImEms:ValidateForRelease . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-68
ValidateForUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-69
PdmItemEms:ValidateForUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-69
RelationEms:ValidateForUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-69
StructurEms:ValidateForUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-69
WrkImEms:ValidateForUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-69
ValidateObjForTransOwnership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-69
PdmRoot:ValidateObjForTransOwnership . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-70
ValRelShipForObjDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-71
TmToCRC:ValRelShipForObjDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-71
WriteClassAttributesPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-72
PdmRoot:WriteClassAttributesPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-72
WriteSchemaHeaderPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-72
WriteXMLAttrsPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-73
PdmRoot:WriteXMLAttrsPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-74
WriteXMLEndTagPre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-74
WriteXMLRootTagPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-74
WriteXMLSubElements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-75
PdmRoot:WriteXMLSubElements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-75

Chapter
1 EMS Messages and Methods
This section lists the messages and methods for Teamcenter Enterprise Data
Exchange (Teamcenter Enterprise Data Exchange) module.
External Messages
This section lists the Teamcenter Enterprise Data Exchange external trusted and
nontrusted messages.
External Trusted Messages

This section lists the Teamcenter Enterprise Data Exchange external trusted
messages.
CheckReplicaSyncStatusD
SYNOPSIS
define trusted external prompting displaying class message

CheckReplicaSyncStatusD
like
SelectedItemSetMsg;
DESCRIPTION
This method is a wrapper method to check the replica sync status for the selected
items from the classic client menu Actions. It calls the UpdateReplicaStatus which
validates the selected Items and initiates the replica sync process for the selected
items.
ARGUMENTS
Same as SelectedItemSetMsg.
PdmItemEms:CheckReplicaSyncStatusD
DESCRIPTION
Checks the sync status of replica object by invoking UpdateReplicaStatusInt on
Synchronizer class.
MT00324 L1 API Reference 1-1

Chapter 1 EMS Messages and Methods
ExportObjectSetDP
SYNOPSIS
define trusted external prompting displaying class message

ExportObjectSetDP
like
SelectedItemSetMsg;
DESCRIPTION
This method is a wrapper method to export selected items from the classic client
menu Actions .It calls the ExportItemInt after the validation of the selected Items .
It supports multiple items export .
ARGUMENTS
Same as SelectedItemSetMsg.
PdmItemEms:ExportObjectSetDP
DESCRIPTION
Submits export request to GS by invoking ExportItemInt on Exporter class.
NOTES
It validates MAR to check export access for the user.
PdmRoot:ExportObjectSetDP
DESCRIPTION
See message description.
1-2 API Reference MT00324 L1

EMS Messages and Methods
InflateDisplayedIcons
DESCRIPTION
The Teamcenter Enterprise Data Exchange module adds the following method(s)
for the InflateDisplayedIcons message.
OwnedItmEms:InflateDisplayedIcons
DESCRIPTION
Custom message to show Replica/Stub/out of date icons for Remote Objects.
PartEms:InflateDisplayedIcons
DESCRIPTION
Custom message to Resolve InflateDisplayedIcons if it is Replica/outofdate.
PdmItemEms:InflateDisplayedIcons
DESCRIPTION
Custom message to show Replica/Stub/out of date icons for Remote Objects.

InflateDisplayedName
DESCRIPTION
for the InflateDisplayedName message.
TransOpt:InflateDisplayedName
DESCRIPTION
Sets the EMSiteName attribute of the TOS GetInfo and Update Dialog Object.

ProcessDialgForSet
DESCRIPTION
The Teamcenter Enterprise Data Exchange module adds the following method(s) for
the ProcessDialgForSet message.
DAttachToSwitch:ProcessDialgForSet
DESCRIPTION
Initiates the Switch attachment action.
DRExport:ProcessDialgForSet
DESCRIPTION
Calls the CreateUserTransferReq message.

SetDialogDefaults
DESCRIPTION
the SetDialogDefaults message.
DClosRuleCre:SetDialogDefaults
DESCRIPTION
Sends the SetDialogDefaultsAtParent message.
Sets the default value for Structure Type.
DGMSCfgCre:SetDialogDefaults
DESCRIPTION
Sends the AtParent message. Sets the attributes for which coresponding config
values are already set.
DGMSCfgGetI:SetDialogDefaults
DESCRIPTION
Sends the AtParent message. Converts the ExporterSpillDBName attribute from
internal format to "display as" format.
DGMSCfgUpd:SetDialogDefaults
DESCRIPTION
Sends the AtParent message. Converts the ExporterSpillDBName attribute from
internal format to "display as" format.
DODSSiteCre:SetDialogDefaults
DESCRIPTION
Creates a full-table-attribute-field on the create dialog to show
for the user with default mapped values.
DODSSiteGetI:SetDialogDefaults
DESCRIPTION
Creates a full-table-attribute-field on the info dialog to show
for the user with values stored in the DB for the object.
DODSSiteUpd:SetDialogDefaults
DESCRIPTION
Creates a full-table-attribute-field on the update dialog to show
for the user with values stored in the DB for the object.
DSiteCre:SetDialogDefaults
DESCRIPTION
None.

DSwitchQry:SetDialogDefaults
DESCRIPTION
Handles the SetDialogDefaults message for the DSwitchQry class. Message type
is an Object Message.
Clears out the OwnerName attribute’s default value.
DTransOptDesc:SetDialogDefaults
DESCRIPTION

ValidateDialgForSet
DESCRIPTION
for the ValidateDialgForSet message.
DAttachToSwitch:ValidateDialgForSet
DESCRIPTION
Validates that the switch selected is not being flipped.
DExportTB:ValidateDialgForSet
DESCRIPTION
DExportTC:ValidateDialgForSet
DESCRIPTION
DImportTB:ValidateDialgForSet
DESCRIPTION
DImportTC:ValidateDialgForSet
DESCRIPTION
DRExport:ValidateDialgForSet
DESCRIPTION

ValidateDialog
DESCRIPTION
for the ValidateDialog message.
DClosRuleCre:ValidateDialog
DESCRIPTION
Validates Create Dialog of ClosRule
DClosRuleUpd:ValidateDialog
DESCRIPTION
Validates Update Dialog of ClosRule
DGMSCfgCre:ValidateDialog
DESCRIPTION
Converts the ExporterSpillDBName attribute from "display as" format to internal
(database) format. Sends the AtParent message.
DGMSCfgUpd:ValidateDialog
DESCRIPTION
Converts the ExporterSpillDBName attribute from "display as" format to internal
(database) format. Sends the AtParent message.
DImportTB:ValidateDialog
DESCRIPTION
DImportTC:ValidateDialog
DESCRIPTION
DODSSiteCre:ValidateDialog
DESCRIPTION
DRemotesrchSearch:ValidateDialog
DESCRIPTION
Validates the dialog box inputs for the remote search action.
DSiteCre:ValidateDialog
DESCRIPTION

DSiteUpd:ValidateDialog
DESCRIPTION
Validates Update Dialog of Site
DSwitchCre:ValidateDialog
DESCRIPTION
Validates Update Dialog of Switch
DSwitchQry:ValidateDialog
DESCRIPTION
Validates Update Dialog of Switch
DTransOptSetCre:ValidateDialog
DESCRIPTION
Validates Create Dialog of Transfer Option Set
DTransOptSetQry:ValidateDialog
DESCRIPTION
Populated the EMSiteID attribute of the TOS Query Dialog Object.
DTransOptSetUpd:ValidateDialog
DESCRIPTION
Validates Update Dialog of Transfer Option Set
DTransTrkUpd:ValidateDialog
DESCRIPTION

Internal Messages
This section lists the Teamcenter Enterprise Data Exchange internal messages.
AttributeToIgnore
SYNOPSIS
define class message AttributeToIgnore

(
input : MTIstring className ::
input : MTIstring attribute ::
output: boolean* ignore ::
output: integer* mfail
)
DESCRIPTION
Argument In/Out Description

className In Class Name.
attribute In Check if attribute can be ignored.
ignore Out Return TRUE if attribute can be ignored
else return FALSE.
mfail Out Method success/failure status:
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
ARGUMENTS
BulkDeletePre
SYNOPSIS
define class message BulkDeletePre

(
input : SetOfObjects reqObjSet ::
)
DESCRIPTION
Method is responsible for deleting request objects.
ARGUMENTS
Arguments In/Out Description

className In Class name


reqObjSet In Set of request objects
*mfail Out method success/failure status
0 - (USC_OKAY) - successful
!0 - unsuccessful
CreateReqObjectPost
SYNOPSIS
define class message CreateReqObjectPost

(
input : SetOfStrings objHdlSet ::
input : MTIstring transferFormula ::
input : SetOfStrings replicaSiteID ::
input : MTIstring masterSiteID ::
input : MTIstring messageID ::
input : MTIstring userID ::
input : NULL MTIstring reason ::
input : NULL MTIstring emailID ::
input : boolean isNotifyEmail ::
input : boolean sync ::
input : boolean priority ::
input : MTIstring reqClass ::
update: ObjectPtr reqObjPtr ::
)
DESCRIPTION
Method is responsible for creating request objects.
ARGUMENTS

objHdlSet In Set of object handles
transferFormula In Transfer formula
replicaSiteID In Set of replica sites
masterSiteID In Owning Site ID
messageID In Message ID
userID In Used id
reason In Reason. May be NULL.
emailID In Email ID. May be NULL.
isNotifyEmail In True if Email Notification selected
sync In If transfer is for Synchronize


priority In Request priority (now / off hours)
reqClass In Requested class name
reqObjPtr In/Out Request Object
!0 - unsuccessful
TcEntReq:CreateReqObjectPost
DESCRIPTION
Provides a customization point. This method is intended to be overwritten.
CreateReqObjectPre
SYNOPSIS
define class message CreateReqObjectPre

(
input : MTIstring messageID ::
update: ObjectPtr reqObjPtr ::
)
DESCRIPTION
ARGUMENTS

messageID In Message ID


userID In Used id
reqObjPtr In/Out Request Object
!0 - unsuccessful
TcEntReq:CreateReqObjectPre
DESCRIPTION
CreateRequestPost
SYNOPSIS
define class message CreateRequestPost

(
input : MTIstring transID ::
input : NULL MTIstring messageId ::
)
DESCRIPTION
ARGUMENTS



transID In Transaction ID
userID In Used id
messageId In Export Request Id generated by Enterprise.
May be NULL.
!0 - unsuccessful
CreateRequestPre
SYNOPSIS
define class message CreateRequestPre

(
input : MTIstring transID ::
)
DESCRIPTION

ARGUMENTS

transID In Transaction ID
userID In Used id
!0 - unsuccessful

DeleteDbObject
DESCRIPTION
the DeleteDbObject message.
ExRecRel:DeleteDbObject
DESCRIPTION
Handles the DeleteDbObject message for the ExRecRel class. Message type is an
ObjectMessage.
Sets the NID as null so that when ExRecRel is deleted, the left side relation is not
deleted.
ImpRec:DeleteDbObject
DESCRIPTION
RelationEms:DeleteDbObject
DESCRIPTION
RelImpRc:DeleteDbObject
DESCRIPTION
Handles the DeleteDbObject message for the RelImpRc class. Message type is
an ObjectMessage.
Sets the NID as NULL so that when RelImpRc is deleted, the left side relation
is not deleted.
DeleteReqObject
SYNOPSIS
define object message DeleteReqObject

(
input : ObjectPtr delObj ::
)
DESCRIPTION
Method is responsible for deleting request object of interest.
ARGUMENTS

delObj In Object to be deleted


!0 - unsuccessful
DeleteReqObjectPost
SYNOPSIS
define object message DeleteReqObjectPost

(
)
DESCRIPTION
Method is responsible to delete request object of interest.
ARGUMENTS

!0 - unsuccessful
DeleteReqObjectPre
SYNOPSIS
define object message DeleteReqObjectPre

(
)
DESCRIPTION
Method is responsible for deleting request object of interest.
ARGUMENTS



!0 - unsuccessful

DoCopyAtOs
DESCRIPTION
for the DoCopyAtOs message.
FSItemEms:DoCopyAtOs
DESCRIPTION
If OwnedItem then call at Parent If Replica then call FMS download

DoCreateRelPost
DESCRIPTION
the DoCreateRelPost message.
TmToCRC:DoCreateRelPost
DESCRIPTION
Provides a place to perform some necessary functions after the relation object is
inserted in the database, but before it is commited to the database.

DoDeleteAuxForRel
DESCRIPTION
the DoDeleteAuxForRel message.
RelImpRc:DoDeleteAuxForRel
DESCRIPTION
Delete the import record if Import record relation gets deleted as a side effect of
infer delete of relation.

DoDeleteRelation
DESCRIPTION
the DoDeleteRelation message.
TmToCRC:DoDeleteRelation
DESCRIPTION
See the message definition.

DoesRelClassValForDel
DESCRIPTION
the DoesRelClassValForDel message.
TmToCRC:DoesRelClassValForDel
DESCRIPTION
Handles the DoesRelClassValForDel message for the TmToCRC class. Message
type is a Class Message.
No messages sent.
NOTES
Returns RLT_VAL_FURTHER_CHECKS_NEEDED

DoesRelSideValForDel
DESCRIPTION
for the DoesRelSideValForDel message.
TmToCRC:DoesRelSideValForDel
DESCRIPTION
Handles the DoesRelSideValForDel message for the TmToCRC class.
RLT_VAL_FURTHER_CHECKS_NEEDED is returned.

DoObjDelAuxForRel
DESCRIPTION
for the DoObjDelAuxForRel message.
ExRecRel:DoObjDelAuxForRel
DESCRIPTION
Deletes the ExpRec object attached with this itemObj.
RelationEms:DoObjDelAuxForRel
DESCRIPTION
As this class is Top level Relation class, it handles the Import Record deletion for all
the relations of the Replica been deleted other than RelImpRc relation and Post an
Event for every deletion of Import Record.
RelImpRc:DoObjDelAuxForRel
DESCRIPTION
Deletes the ImpRec object attached with this itemObj.
ExportObjectToXMLPost
SYNOPSIS
define object overridable message ExportObjectToXMLPost

(
update: ObjectPtr objectPtr ::
input : MTIstring exportIntent ::
input : MTIstring siteId ::
input : MTIstring tcGSMessageID ::
input : ObjectPtr transferFormulaObj ::
output: SetOfStrings* xmlStreamSet ::
)
DESCRIPTION
Post customization hook for writing the object to XML file and create/update the
Export Record.
ARGUMENTS

objectPtr In/Out The object to Export
exportIntent In Export Intent
siteId In The replica site ID
tcGSMessageID In TcGS message ID for Transaction
transferFormulaObj In Transfer formula Object pointer


xmlStreamSet Out XML strings to be added to metadata file
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
PdmRoot:ExportObjectToXMLPost
DESCRIPTION

ExpSetGetRelationCtxt
DESCRIPTION
the ExpSetGetRelationCtxt message.
FilterOtherSideObjAndRel
SYNOPSIS
define object overridable message FilterOtherSideObjAndRel

(
input : ObjectPtr thisObj ::
input : SetOfObjects localOtherSideObjs ::
input : NULL SetOfObjects localRelObjs ::
output: SetOfObjects* filteredOtherSideObjs ::
output: SetOfObjects* filteredOtherSideRelObjs ::
)
DESCRIPTION
Provides a customization hook to filter the set of other side objects and corresponding
relation if gathered by expanding a relation, which will be exported. E.g. latest other
side object can be decided using Revision, Sequence, VersionNumber attributes.
ARGUMENTS

thisObj In The object from which expansion is done
localOtherSideObjs In Set containing other side objects
localRelObjs In Set containing relations for other side objects.
May be NULL if the other side objects are
gathered using closure rule having foreign
keys.
filteredOtherSideObjs Out Set containing other side filtered objects
filteredOtherSideRelObjs Out Set containing relations for other side filtered
objects
0 Successful.
!0 Unsuccessful.
NOTES
Customization can override this message and filter other side objects and relations.

PdmItemEms:FilterOtherSideObjAndRel
DESCRIPTION
Filters and returns only the latest object in the series. The filteration is done only for
relation based closure rule expansion i.e. when the input relation set is not empty.

FindEquivalentLocalObject
DESCRIPTION
the FindEquivalentLocalObject message.
OwnedItmEms:FindEquivalentLocalObject
DESCRIPTION
See the message description.
PdmItemEms:FindEquivalentLocalObject
DESCRIPTION
PdmRoot:FindEquivalentLocalObject
DESCRIPTION
RelationEms:FindEquivalentLocalObject
DESCRIPTION
Stub:FindEquivalentLocalObject
DESCRIPTION
FindLocalObject
SYNOPSIS
define object overridable message FindLocalObject

(
input : ObjectPtr objToImp ::
input : ObjectPtr objGSI ::
input : NULL SetOfObjects processedObjsInFactr ::
input : ObjectPtr transFormulaObj ::
output: ObjectPtr* foundPtr ::
output: boolean* isPrimaryObjProcessed ::
output: ObjectPtr* foundImpRec ::
)
DESCRIPTION
Responsible for checking the existence of the object in local cache/query for the local
object and if found, return the local object, its type and the import record if any
available for the local object. 1. This message tries finding an object based on GS
identity. 2. If object is not found from #1 then object will be queried from the database

based on closure rules. This case will find out the equivalent local objects from the
objects generated by mapper.
ARGUMENTS

objToImp In Object to be imported
objGSI In Object’s GS Identity
processedObjsInFactr n Processed Objects in Factor. May be NULL.
I
transFormulaObj In Transfer formula
foundPtr Out Local Object
isPrimaryProcessed Out Is primary Object Processed
foundImpRec Out Import Record of an object
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
OwnedItmEms:FindLocalObject
DESCRIPTION
PdmItemEms:FindLocalObject
DESCRIPTION
PdmRoot:FindLocalObject
DESCRIPTION
RelationEms:FindLocalObject
DESCRIPTION
GatherClassesToExportPost
SYNOPSIS
define class overridable message GatherClassesToExportPost

(
output: SetOfStrings* metaClasses ::
)

DESCRIPTION
Provides a customization point. This method is intended to be overridden.
gument In/Out Description

assName In Class Name.
taClasses Out Set into which all MODeL persistent
will be written.
ail Out Method success/failure status:
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
ARGUMENTS
PdmRoot:GatherClassesToExportPost
DESCRIPTION
GenerateMessageID
SYNOPSIS
DESCRIPTION
Generates a unique client message ID.
ARGUMENTS

className In Class Name
selectedItems In Selected Items list
messageId Out Client Message ID, may be NULL.
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
TransTrk:GenerateMessageID
DESCRIPTION

GetCheckInMode
DESCRIPTION
the GetCheckInMode message.
GetClientID
SYNOPSIS
DESCRIPTION
Returns a client ID from the given transaction ID
ARGUMENTS

transID In Transaction ID.
siteID In Site ID
clientID Out Client ID.
0 (USC_OKAY) Successful.
0 Unsuccessful.
MultiSite:GetClientID
DESCRIPTION
GetClientIDfromTrnFormula
SYNOPSIS
define class message GetClientIDfromTrnFormula

(
input : MTIstring siteId ::
input : MTIstring trnFormulaXml ::
output: MTIstring* clientID ::
)
DESCRIPTION
Extracts the client message ID from the Transfer Formula XML string.

ARGUMENTS

className In Class name.
siteId In Replica Site ID.
trnFormulaXml In Transfer Formula XML string.
clientID Out Client Message ID. May be NULL.
mfail Out method success/failure status 0 - method was
successful. !0 - method was unsuccessful.
TransferFormula:GetClientIDfromTrnFormula
DESCRIPTION
GetCustomOptions
SYNOPSIS
define class overridable message GetCustomOptions

(
input : ObjectPtr dialogObj ::
output: NVSET* cusSessionOpts ::
)
DESCRIPTION
This API may be used to add an option along with a value to the transfer formula
XML string while submitting an export request. The option name and value should
be populated in the output name value set. More than one option may be populated.
ARGUMENTS

dialogObj In Dialog object for Export action
cusSessionOpts Out Name Value set to be populated with the
option name and corresponding value, that
would be used by OOTB code to populate the
XML string.
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.

NOTES
The calling function should free cusSessionOpts using
FREE_String(cusSessionOpts).
TransOpt:GetCustomOptions
DESCRIPTION
GetMergedObject
SYNOPSIS
define object overridable message GetMergedObject

(
input : ObjectPtr objToImport ::
input : ObjectPtr gsIdObj ::
update: ObjectPtr localObj ::
output: boolean* doUpdate ::
)
DESCRIPTION
Updates the attributes on the local object from the xml object. Returns doUpdate
as TRUE if any one attribute is found to be different between the local object and
xml object.
ARGUMENTS

objToImport In Source Object
gsIdObj In Gs Id of an Object
localObj In/Out Destination Object
doUpdate Out Whether object is updated or not
mfail Out Method success/failure status: 0 Successful.
!0 Unsuccessful.
NOTES
Also see GetAttrLstToUpdOnAncstrRepl
GetMultipleRootObjects
SYNOPSIS
define object message GetMultipleRootObjects

(
input : ObjectPtr transferFormulaObj ::
output: SetOfObjects* rootObjects ::
)

DESCRIPTION
API to get the multiple root objects depending upon the given user selected object
and the transfer formula.
ARGUMENTS

thisObj In User selected object to export
transferFormulaObj In Transfer formula Object
rootObjects Out Objects retrieved as root objects w.r.t. Transfer
Formula
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
GenDoc:GetMultipleRootObjects
DESCRIPTION
Returns the input object for selected version option. Returns the latest revision for
latest version option. Returns all revisions of the document for all version option.
ItemMstr:GetMultipleRootObjects
DESCRIPTION
Returns the latest revision of the object for latest version option. Returns all
revisions for all version option and returns error (mfail) if invoked with selected
version option.
PdmItemEms:GetMultipleRootObjects
DESCRIPTION
Copies the input object to the output set.
StrucBI:GetMultipleRootObjects
DESCRIPTION
For Selected Version option, copies the input object to the output set and for Latest
and All version options invokes the same API on the master.
GetObjectsInSeriesForOwnTransfer
SYNOPSIS
define object message GetObjectsInSeriesForOwnTransfer

(
input : ObjectPtr factorObject ::
input : MTIstring replicaSiteId ::
output: SetOfObjects* objsInSeries ::

DESCRIPTION
Get the objects in a Series for Ownership Transfer. By default, gets already
replicated Version in Series to the given Replica Site.
ARGUMENTS

factorObject In Object
replicaSiteId In The replica site id
objsInSeries Out Objects in Series which need to transfer for
ownership.
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
NOTES
The calling message should free all the output parameters
WrkImEms:GetObjectsInSeriesForOwnTransfer
DESCRIPTION
GetOdrForImportAux
SYNOPSIS
define object message GetOdrForImportAux

(
update: ObjectPtr thisObj ::
input : MTIstring ownerName ::
output: ObjectPtr* ownerDirObj ::
)
DESCRIPTION
A customization point to allow the setting/overriding of the OwnerDir value for an
object being imported.
ARGUMENTS

thisObj In/Out Object being imported
ownerName In Name of the object’s owner


ownerDirObj Out The Owner Dir that was selected
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
FSItemEms:GetOdrForImportAux
DESCRIPTION
NOTES
A no-op for the customization point at this class.
GetOwnerForImport
SYNOPSIS
define object message GetOwnerForImport

(
)
DESCRIPTION
A customization point to allow the setting/overriding of the OwnerName value
for an object being imported.
ARGUMENTS

0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
OwnedItmEms:GetOwnerForImport
DESCRIPTION
NOTES
A no-op for the customization point at this class.

GetPredForOwnershipTransfer
SYNOPSIS
define object message GetPredForOwnershipTransfer

(
output: ObjectPtr* predObj ::
)
DESCRIPTION
Get the predecessor of the object for Ownership Transfer.
ARGUMENTS

thisObj In Object whose predecessor is found
predObj Out Predecessor object, may be NULL
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
NOTES
The calling message should free all the output parameters
GetRootObject
SYNOPSIS
define object overridable message GetRootObject

(
input : ObjectPtr trsfrFormulaObjPtr ::
output: ObjectPtr* rootObject ::
)
DESCRIPTION
This method traverses and collects the root objects for all the items selected for
the Export .In core it is a no-op method .
ARGUMENTS

thisObj In I/P Object .
trsfrFormulaObjPtr In Transfer formula Object .


rootObject Out Root Object for thisObj.
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
PdmItemEms:GetRootObject
DESCRIPTION
GetTeamFolderForObj
SYNOPSIS
define deprecated object overridable message GetTeamFolderForObj

(
output: MTIstring* emsTeamFolderName ::
output: boolean* addToTeamFolder ::
)
DESCRIPTION
This message returns a Team Folder name and whether the input object should
be added to the Team Folder.
ARGUMENTS

thisObj In This object
emsTeamFolderName Out Team Folder name that the input object is to
be related to.
addToTeamFolder Out Boolean to convey whether the input object
should be added to the Team Folder.
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
NOTES
This message is deprecated. See the Release Bulletin for replacement messages.

BinFile:GetTeamFolderForObj
DESCRIPTION
NOTES
This code is introduced as there is no seperate module for IDS We want to prevent
addition of the CADFile objects to the team folder the BinFile is the immediate
parent of IDSFile which is the immediate parent of CADFILE which is present in
the core modules hence the check for CADDoc has been added here
None.
GnDocDmm:GetTeamFolderForObj
DESCRIPTION
NOTES
This code is introduced as there is no seperate module for IDS We want to prevent
addition of the CADDoc objects to the team folder the GnDocDmm is the immediate
parent of CADDoc which is present in the core modules hence the check for CADDoc
has been added here
None.
JT:GetTeamFolderForObj
DESCRIPTION
WrkImEms:GetTeamFolderForObj
DESCRIPTION
Returns the Team Folder name and whether the input object should be added to the
Folder depending on the DestinationFolderName attribute on the object.

ImportFromXMLToDbPost
DESCRIPTION
the ImportFromXMLToDbPost message.
PdmRoot:ImportFromXMLToDbPost
DESCRIPTION

ImportFromXMLToDbPre
DESCRIPTION
the ImportFromXMLToDbPre message.
PdmRoot:ImportFromXMLToDbPre
DESCRIPTION
VewDepR:ImportFromXMLToDbPre
DESCRIPTION
InflateDynamicAttrExportPre
SYNOPSIS
define object message InflateDynamicAttrExportPre

(
)
DESCRIPTION
Customization hook for Inflating the dynamic attribute(s) on the object before
exporting. The custom code must not update the object in database.
ument In/Out Description

sObj In/Out Object whose dynamic attribute(s)
has to be inflated.
il Out Method success/failure status:
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
ARGUMENTS
InflateRequiredDynamicAttributes
SYNOPSIS
define object overridable message InflateRequiredDynamicAttributes

(
update: ObjectPtr localObj ::

DESCRIPTION
Sets the dynamic attributes on the input object. Any dynamic attribute that is added
in GetAttrLstToUpdOnAncstrRepl should be populated by overriding this API.
ARGUMENTS

localObj In/Out The input object on which the dynamic
attributes are to be set
mfail Out Method success/failure status 0 Successful. !0
Unsuccessful.
WrkImEms:InflateRequiredDynamicAttributes
DESCRIPTION
Calls at Parent and then sets the dynamic attribute DestinationFolderName on
the input object

InsertDbItem
DESCRIPTION
for the InsertDbItem message.
OwnedItmEms:InsertDbItem
DESCRIPTION
PdmItemEms:InsertDbItem
DESCRIPTION

InsertDbRelation
DESCRIPTION
the InsertDbRelation message.
RelationEms:InsertDbRelation
DESCRIPTION
IsOTAllowedForImmutable
SYNOPSIS
define object message IsOTAllowedForImmutable

(
output: boolean* isOTAllowed ::
)
DESCRIPTION
Decides whether ownership transfer is allowed for immutable object.
ARGUMENTS

thisObj In The object.
isOTAllowed Out Whether OT is allowed.
0 Successful.
!0 Unsuccessful.
WrkImEms:IsOTAllowedForImmutable
DESCRIPTION

MoveDbItem
DESCRIPTION
for the MoveDbItem message.
OwnedItmEms:MoveDbItem
DESCRIPTION
NOTES
Cannot move a object from a replicated database.
PdmItemEms:MoveDbItem
DESCRIPTION
NOTES
Cannot move a object from a replicated database.
NotifyObjectOwnershipTransferred
SYNOPSIS
define object message NotifyObjectOwnershipTransferred

(
input : ObjectPtr exportObj ::
)
DESCRIPTION
This hook is to be used in customization to send notification that the ownership
of exportObj is changed. The new owner of the object is available in EMSSiteID
attribute on the object.
ARGUMENTS

exportObj In Object for which OT happens
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
PdmRoot:NotifyObjectOwnershipTransferred
DESCRIPTION

PropagateOccurrences
DESCRIPTION
for the PropagateOccurrences message.

RefreshDbObject
DESCRIPTION
the RefreshDbObject message.
OwnedItmEms:RefreshDbObject
DESCRIPTION
PdmItemEms:RefreshDbObject
DESCRIPTION
RelationEms:RefreshDbObject
DESCRIPTION
SetDefaultValues
SYNOPSIS
define deprecated object message SetDefaultValues

(
update: ObjectPtr* objToImp ::
)
DESCRIPTION
Resolves and sets Left and Right attributes.
ARGUMENTS

Object In/Out Object whose default values can be set before
the object is inserted into the database
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
NOTES
This message is deprecated. See the Release Bulletin for replacement messages.

PdmRoot:SetDefaultValues
DESCRIPTION

SetDialgDefaultsForSet
DESCRIPTION
the SetDialgDefaultsForSet message.
DImportTB:SetDialgDefaultsForSet
DESCRIPTION
DImportTC:SetDialgDefaultsForSet
DESCRIPTION
DRemotesrchPublish:SetDialgDefaultsForSet
DESCRIPTION
DRemotesrchUnpublish:SetDialgDefaultsForSet
DESCRIPTION
SetImportAttrsAux
SYNOPSIS
define object message SetImportAttrsAux

(
)
DESCRIPTION
Called to allow setting/resetting of attributes after an import objects has been
created from the XML input.
ARGUMENTS

0 - Successful.
(USC_OKAY)
!0 Unsuccessful.

FSItemEms:SetImportAttrsAux
DESCRIPTION
NOTES
Calls the customization point to set/reset the OwnerDirName
OwnedItmEms:SetImportAttrsAux
DESCRIPTION
NOTES
Calls the customization point to set the OwnerName
PdmRoot:SetImportAttrsAux
DESCRIPTION
NOTES
Empty at this class

SetRelationDefaults
DESCRIPTION
for the SetRelationDefaults message.
TmToCRC:SetRelationDefaults
DESCRIPTION
Sends the SetRelationDefaultsAtParent message.
Places the value of the TransferMode attribute from the related Transfer Mode
object into the TransferMode attribute of the TmToCRC relation object.
Places the value of the ClosureRuleName attribute from the related ClosureRule
object into the ClosureRuleName attribute of the TmToCRC relation object.
SetSessionOptValueInFormula
SYNOPSIS
define object message SetSessionOptValueInFormula

(
update: ObjectPtr trsfrFormulaObj ::
input : MTIstring optionName ::
input : MTIstring optionValue ::
)
DESCRIPTION
This method sets the optionValue to optionName attribute on SesnOptionValue
attribute(NVSet) in transfer formula object.
ARGUMENTS

trsfrFormulaObj In/Out Transfer formula Object.
optionName In Session option name .
optionValue In Value of session option in formula.
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
TransferFormula:SetSessionOptValueInFormula
DESCRIPTION

SubmitExportRequest
SYNOPSIS
define class message SubmitExportRequest

(
input : SetOfObjects selectedObjects ::
update: ObjectPtr exportDlgObj ::
output: MTIstring* messageId ::
output: SetOfObjects* failedObjects ::
)
DESCRIPTION
Submits export request to Global Services for the selected objects.
ARGUMENTS

selectedObjects In Objects to be exported
exportDlgObj In/Out Export dialog
messageId Out Export Request Id generated by Enterprise.
failedObjects Out Objects which cannot be exported
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
NOTES
1. API does not check for Message Access Privileges of the user performing the
action for Ownership Transfer. It is client’s responsibility to check for these
privileges before invoking this API.
2. API does not guarantee the successful data transfer.
Exporter:SubmitExportRequest
DESCRIPTION
SubmitRequestToGS
SYNOPSIS
define object message SubmitRequestToGS

(


)
DESCRIPTION
Sumbit request object to GS Handler if request not in Life cycle.
ARGUMENTS

thisObj In Object pointer
!0 - unsuccessful

UpdateDbObject
DESCRIPTION
the UpdateDbObject message.
OwnedItmEms:UpdateDbObject
DESCRIPTION
PdmItemEms:UpdateDbObject
DESCRIPTION
RelationEms:UpdateDbObject
DESCRIPTION
UpdateObjForExportPre
SYNOPSIS
define object overridable message UpdateObjForExportPre

(
input : MTIstring replicaSiteId ::
input : ObjectPtr trsfrFormulaObjPtr ::
)
DESCRIPTION
Hook for custom code to populate any custom attributes on an object before it is
exported.
ARGUMENTS

thisObj In/Out Object being Exported.
replicaSiteId In Site Id.
trsfrFormulaObjPtr In Export Transfer Formula.
mfail Out Method success/failure status: Successful.
Unsuccessful.
NOTES
1. This hook may be called more than once per object.

2. The Exporter supports many types of attributes. Any attributes populated by

this hook of a supported type will be exported to the XML by the Exporter. To
write attributes of other types (not supported by the Exporter), the custom code
may use WriteXMLAttrsPost.
3. The Exporter makes decisions about how to export each object using the
attributes of the object immediately following this hook. The object must not
change after this hook; if the object changes after this hook, the Exporter may
terminate the operation with a non-zero mfail.
4. The object to be updated needs to be locked using LockDbObjRefresh API.

After updating the object in the database, RefreshDbObject should be called
on the object.
5. The updation to the object should not affect the validation check for export of
that object, e.g. the updation should not make the object Export Protected.
EXAMPLES
SEE ALSO
WriteXMLAttrsPost
PdmRoot:UpdateObjForExportPre
DESCRIPTION

ValForUnregister
DESCRIPTION
the ValForUnregister message.
ValidateExportDialog
SYNOPSIS
define object message ValidateExportDialog

(
)
DESCRIPTION
Validates exporter dialog fields.
ARGUMENTS

thisObj In/Out Export Dialog
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
DRExport:ValidateExportDialog
DESCRIPTION

ValidateForCheckIn
DESCRIPTION
the ValidateForCheckIn message.
WrkImEms:ValidateForCheckIn
DESCRIPTION
Check-in is denied if the object is Stub/Replica.

ValidateForCheckOut
DESCRIPTION
for the ValidateForCheckOut message.
WrkImEms:ValidateForCheckOut
DESCRIPTION
Checkin is denied if the workitem is Stub/Replica.

ValidateForCkiToTeam
DESCRIPTION
for the ValidateForCkiToTeam message.
WrkImEms:ValidateForCkiToTeam
DESCRIPTION
Check-in to Team is denied if the object is Stub/Replica.

ValidateForCkoFromTeam
DESCRIPTION
the ValidateForCkoFromTeam message.
WrkImEms:ValidateForCkoFromTeam
DESCRIPTION
Check-out from Team is denied if the object is Stub/Replica.

ValidateForCopy
DESCRIPTION
the ValidateForCopy message.
WrkImEms:ValidateForCopy
DESCRIPTION
Copy action is denied if the workitem is Stub/Replica.

ValidateForCreate
DESCRIPTION
the ValidateForCreate message.
GMSCfg:ValidateForCreate
DESCRIPTION
Ensures there is always only one object of the GMSCfg class. Presents an error
message if there is already one else sends the AtParent message.

ValidateForCreateRel
DESCRIPTION
for the ValidateForCreateRel message.
RelationEms:ValidateForCreateRel
DESCRIPTION
This is to validate relation creation for Replicas.
StructurEms:ValidateForCreateRel
DESCRIPTION
This is to validate Structure relation creation for Replicas.

ValidateForDelete
DESCRIPTION
the ValidateForDelete message.
GMSCfg:ValidateForDelete
DESCRIPTION
PdmItemEms:ValidateForDelete
DESCRIPTION
Switch:ValidateForDelete
DESCRIPTION
TransTrk:ValidateForDelete
DESCRIPTION
WrkImEms:ValidateForDelete
DESCRIPTION

ValidateForRelease
DESCRIPTION
the ValidateForRelease message.
WrkImEms:ValidateForRelease
DESCRIPTION

ValidateForUpdate
DESCRIPTION
the ValidateForUpdate message.
PdmItemEms:ValidateForUpdate
DESCRIPTION
See message description
RelationEms:ValidateForUpdate
DESCRIPTION
StructurEms:ValidateForUpdate
DESCRIPTION
This is to validate Structure relation creation for Replicas.
WrkImEms:ValidateForUpdate
DESCRIPTION
ValidateObjForTransOwnership
SYNOPSIS
define object message ValidateObjForTransOwnership

(
input : ObjectPtr selectedObj ::
input : MTIstring newMasterSiteID ::
output: boolean* isValid ::
)
DESCRIPTION
This message should be used to validate whether an object is suitable for ownership
transfer while submitting export request. This method assumes that the transfer
request on ’selectedObj’ is for ownership transfer.
ARGUMENTS

selectedObj In Selected Node in a BOM
newMasterSiteID In site is to which ownership is happening
isValid Out Is object valid for OT?


0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
PdmRoot:ValidateObjForTransOwnership
DESCRIPTION

ValRelShipForObjDelete
DESCRIPTION
the ValRelShipForObjDelete message.
TmToCRC:ValRelShipForObjDelete
DESCRIPTION
Handles the ValRelShipForObjDelete message for the TmToCRC class.
Checks to make sure that a TransferMode does not have a Closure Rule validation
and a Closure Rules does not have validations: if so, delete denied.
If the delete is not allowed then the method will return USC_VALIDATION_ERROR
in the mfail parameter. If the delete is allowed, USC_OKAY will be returned.
Sends ValRelShipForObjDeleteAtParent.

WriteClassAttributesPost
DESCRIPTION
the WriteClassAttributesPost message.
PdmRoot:WriteClassAttributesPost
DESCRIPTION
Argument In/Out Description

className In Class Name.
xsdStrSet In/Out Set into which the schema elements
will be placed.
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
WriteSchemaHeaderPost
SYNOPSIS
define class overridable message WriteSchemaHeaderPost

(
output: SetOfStrings* schemaLineSet ::
)
DESCRIPTION
Provides a customization point. This method is intended to be overridden.
gument In/Out Description

assName In Class Name.
hemaLineSet Out Set into which the schema elements
will be placed.
ail Out Method success/failure status:
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.

ARGUMENTS
WriteXMLAttrsPost
SYNOPSIS
define object overridable message WriteXMLAttrsPost

(
input : ObjectPtr object ::
update: SetOfStrings* xmlStrSet ::
)
DESCRIPTION
Dump an object’s attributes to File in XML format.
ARGUMENTS

object In An object to dump.
xmlStrSet In/Out Set of strings to be written in XML.
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
NOTES
1. This hook is called precisely once per exported object.
2. All attributes of a supported type will be exported to the XML by the Exporter.
This hook is available specifically for writing attributes of types not supported
by the Exporter.
3. When this hook is called, the Exporter has already made decisions about how to
export the object using the attributes of the object. The object must not change
in this hook; if the object changes in this hook, the Exporter may terminate the
operation with a non-zero mfail. The appropriate hook for modifying an object’s
attributes prior to export is UpdateObjForExportPre, which see.
EXAMPLES
LMD="2006-11-02T15:33:18.244" Site="TcEntSite" Id="qlcpBiipni3w0ids-----abo"

BBoxMaxX="0" BBoxMaxY="0" BBoxMaxZ="0" BBoxMinX="0" BBoxMinY="0" BBoxMinZ="0"
CheckedOut="false" Creator="super user" ExternallyManaged="false" FrozenIndicator="false"
IsComponent="false" ItemMstrOBID="qlcpBjdpni3w0ids-----abo" Nomenclature="TestAsm"
Official="false" OriginalCreationDate="2006-11-02T15:33:18.228" OriginalCreator="super user"
OwnerName="super user" PartNumber="TestAsm" RefCopied="false" Reserved="false" Revision="A"
Sequence="1" StdPartIndicator="false" Superseded="false" SupersededByCkiCko="false"
SupersededByRevVersn="false" VersionNumber="1" ZBlob="+"
SEE ALSO
UpdateObjForExportPre

PdmRoot:WriteXMLAttrsPost
DESCRIPTION
WriteXMLEndTagPre
SYNOPSIS
define class message WriteXMLEndTagPre

(
input : MTIstring namespacePrefix ::
input : MTIstring tagName ::
output: SetOfStrings* xmlStrSet ::
)
DESCRIPTION
Write the data before end tag of an XML document. Any XML data customizer need
to write at the end of XML file and be created/sent here.
ARGUMENTS

className In class name.
namespacePrefix In The namespace prefix to use on the XML
tag. namespacePrefix must not include the
separating colon ":".
tagName In Name of the tag
xmlStrSet Out Set of strings to be written in XML.
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
WriteXMLRootTagPost
SYNOPSIS
define class overridable message WriteXMLRootTagPost

(
output: SetOfStrings* formatSet ::
)

DESCRIPTION
Write the Root Tag, "ObjectSetRoot", of an XML document containing a set of
objects to a string.
ARGUMENTS

formatSet Out Set of strings to be written in XML.
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
WriteXMLSubElements
SYNOPSIS
define object overridable message WriteXMLSubElements

(
input : ObjectPtr object ::
update: SetOfStrings formatSet ::
)
DESCRIPTION
Write custom XML Sub element to Set of strings.
ARGUMENTS

object In Object pointer
formatSet In/Out Set of strings to be written in XML.
0 - Successful.
(USC_OKAY)
!0 Unsuccessful.
PdmRoot:WriteXMLSubElements
DESCRIPTION
See message description

Index
A DGMSCfgCre:SetDialogDefaults . . . . . . 1-6
DGMSCfgCre:ValidateDialog . . . . . . . . . 1-9
AttributeToIgnore . . . . . . . . . . . . . . . . 1-12
DGMSCfgGetI:SetDialogDefaults . . . . . . 1-6
Audience . . . . . . . . . . . . . . . . . . . . . . . . 5
DGMSCfgUpd:SetDialogDefaults . . . . . . 1-6
DGMSCfgUpd:ValidateDialog . . . . . . . . 1-9
B DImportTB:SetDialgDefaultsForSet . . . 1-52
BinFile:GetTeamFolderForObj . . . . . . . 1-42 DImportTB:ValidateDialgForSet . . . . . . 1-8
BulkDeletePre . . . . . . . . . . . . . . . . . . 1-12 DImportTB:ValidateDialog . . . . . . . . . . 1-9
DImportTC:SetDialgDefaultsForSet . . . 1-52
DImportTC:ValidateDialgForSet . . . . . . 1-8
C DImportTC:ValidateDialog . . . . . . . . . . 1-9
CheckReplicaSyncStatusD . . . . . . . . . . . 1-1 DoCopyAtOs (Teamcenter Enterprise Data
Code conventions . . . . . . . . . . . ....... 7 Exchange) . . . . . . . . . . . . . . . . . . . . . 1-21
Command line entry conventions ....... 7 DoCreateRelPost (Teamcenter Enterprise
Conventions Data Exchange) . . . . . . . . . . . . . . . . . 1-22
Caution icons . . . . . . . . . . . . . . . . . . .. 6 DoDeleteAuxForRel (Teamcenter Enterprise
Code . . . . . . . . . . . . . . . . . . . . . . . . .. 7 Data Exchange) . . . . . . . . . . . . . . . . . 1-23
Command line entries . . . . . . . . . . . .. 7 DoDeleteRelation (Teamcenter Enterprise
File contents . . . . . . . . . . . . . . . . . . .. 7 Data Exchange) . . . . . . . . . . . . . . . . . 1-24
Names . . . . . . . . . . . . . . . . . . . . . . .. 6 DODSSiteCre:SetDialogDefaults . . . . . . 1-6
Note icons . . . . . . . . . . . . . . . . . . . . .. 6 DODSSiteCre:ValidateDialog . . . . . . . . . 1-9
Revisions . . . . . . . . . . . . . . . . . . . . .. 6 DODSSiteGetI:SetDialogDefaults . . . . . . 1-6
Syntax definitions . . . . . . . . . . . . . . .. 8 DODSSiteUpd:SetDialogDefaults . . . . . . 1-6
Values . . . . . . . . . . . . . . . . . . . . . . . .. 6 DoesRelClassValForDel (Teamcenter
Warning icons . . . . . . . . . . . . . . . . . .. 6 Enterprise Data Exchange) . . . . . . . . 1-25
CreateReqObjectPost . . . . . . . . . . . . . . 1-13 DoesRelSideValForDel (Teamcenter
CreateReqObjectPre . . . . . . . . . . . . . . 1-14 Enterprise Data Exchange) . . . . . . . . 1-26
CreateRequestPost . . . . . . . . . . . . . . . 1-15 DoObjDelAuxForRel (Teamcenter Enterprise
CreateRequestPre . . . . . . . . . . . . . . . . 1-16 Data Exchange) . . . . . . . . . . . . . . . . . 1-27
DRemotesrchPublish:SetDialgDefaultsForSet . . 1-52
DRemotesrchSearch:ValidateDialog . . . . 1-9
D
DRemotesrchUnpublish:SetDialgDefaultsForSet . . 1-52
DAttachToSwitch:ProcessDialgForSet . . . 1-5 DRExport:ProcessDialgForSet . . . . . . . . 1-5
DAttachToSwitch:ValidateDialgForSet . . 1-8 DRExport:ValidateDialgForSet . . . . . . . . 1-8
DClosRuleCre:SetDialogDefaults . . . . . . 1-6 DRExport:ValidateExportDialog . . . . . . 1-59
DClosRuleCre:ValidateDialog . . . . . . . . . 1-9 DSiteCre:SetDialogDefaults . . . . . . . . . . 1-6
DClosRuleUpd:ValidateDialog . . . . . . . . 1-9 DSiteCre:ValidateDialog . . . . . . . . . . . . 1-9
DeleteDbObject (Teamcenter Enterprise Data DSiteUpd:ValidateDialog . . . . . . . . . . . 1-10
Exchange) . . . . . . . . . . . . . . . . . . . . . 1-18 DSwitchCre:ValidateDialog . . . . . . . . . 1-10
DeleteReqObject . . . . . . . . . . . . . . . . . 1-18 DSwitchQry:SetDialogDefaults . . . . . . . 1-7
DeleteReqObjectPost . . . . . . . . . . . . . . 1-19 DSwitchQry:ValidateDialog . . . . . . . . . 1-10
DeleteReqObjectPre . . . . . . . . . . . . . . 1-19 DTransOptDesc:SetDialogDefaults . . . . . 1-7
DExportTB:ValidateDialgForSet . . . . . . . 1-8 DTransOptSetCre:ValidateDialog . . . . . 1-10
DExportTC:ValidateDialgForSet . . . . . . . 1-8 DTransOptSetQry:ValidateDialog . . . . . 1-10
MT00324 L1 API Reference Index-1

Index
DTransOptSetUpd:ValidateDialog . . . . 1-10 InflateDisplayedName (Teamcenter

DTransTrkUpd:ValidateDialog . . . . . . . 1-10 Enterprise Data Exchange) . . . . . . . . . 1-4
InflateDynamicAttrExportPre . . . . . . . 1-44
E InflateRequiredDynamicAttributes . . . . 1-44
InsertDbItem (Teamcenter Enterprise Data
Exporter:SubmitExportRequest . . . . . . 1-55
Exchange) . . . . . . . . . . . . . . . . . . . . . 1-46
ExportObjectSetDP . . . . . . . . . . . . . . . . 1-2
InsertDbRelation (Teamcenter Enterprise
ExportObjectToXMLPost . . . . . . . . . . . 1-27
Data Exchange) . . . . . . . . . . . . . . . . . 1-47
ExpSetGetRelationCtxt (Teamcenter
IsOTAllowedForImmutable . . . . . . . . . 1-47
Enterprise Data Exchange) . . . . . . . . 1-29
ItemMstr:GetMultipleRootObjects . . . . 1-37
ExRecRel:DeleteDbObject . . . . . . . . . . 1-18
ExRecRel:DoObjDelAuxForRel . . . . . . . 1-27
J
F JT:GetTeamFolderForObj . . . . . . . . . . . 1-42
File contents conventions . . . . . . . . . . . .. 7
FilterOtherSideObjAndRel . . . . . . . . . . 1-29 M
FindEquivalentLocalObject (Teamcenter Manual
Enterprise Data Exchange) . . . . . . . . 1-31 Audience . . . . . . . . . . . . . . . . . . . . . . . 5
FindLocalObject . . . . . . . . . . . . . . . . . 1-31 MoveDbItem (Teamcenter Enterprise Data
FSItemEms:DoCopyAtOs . . . . . . . . . . . 1-21 Exchange) . . . . . . . . . . . . . . . . . . . . . 1-48
FSItemEms:GetOdrForImportAux . . . . 1-39 MultiSite:GetClientID . . . . . . . . . . . . . 1-34
FSItemEms:SetImportAttrsAux . . . . . . 1-53
N
G
Name conventions . . . . . . . . . . . . . . . . . . 6
GatherClassesToExportPost . . . . . . . . . 1-32 NotifyObjectOwnershipTransferred . . . 1-48
GenDoc:GetMultipleRootObjects . . . . . 1-37
GenerateMessageID . . . . . . . . . . . . . . 1-33
O
GetCheckInMode (Teamcenter Enterprise
Data Exchange) . . . . . . . . . . . . . . . . . 1-34 OwnedItmEms:FindEquivalentLocalObject . . 1-31
GetClientID . . . . . . . . . . . . . . . . . . . . 1-34 OwnedItmEms:FindLocalObject . . . . . . 1-32
GetClientIDfromTrnFormula . . . . . . . . 1-34 OwnedItmEms:GetOwnerForImport . . . 1-39
GetCustomOptions . . . . . . . . . . . . . . . 1-35 OwnedItmEms:InflateDisplayedIcons . . . 1-3
GetMergedObject . . . . . . . . . . . . . . . . 1-36 OwnedItmEms:InsertDbItem . . . . . . . . 1-46
GetMultipleRootObjects . . . . . . . . . . . . 1-36 OwnedItmEms:MoveDbItem . . . . . . . . 1-48
GetObjectsInSeriesForOwnTransfer . . . 1-37 OwnedItmEms:RefreshDbObject . . . . . 1-50
GetOdrForImportAux . . . . . . . . . . . . . 1-38 OwnedItmEms:SetImportAttrsAux . . . . 1-53
GetOwnerForImport . . . . . . . . . . . . . . 1-39 OwnedItmEms:UpdateDbObject . . . . . . 1-57
GetPredForOwnershipTransfer . . . . . . 1-40
GetRootObject . . . . . . . . . . . . . . . . . . 1-40 P
GetTeamFolderForObj . . . . . . . . . . . . . 1-41
PartEms:InflateDisplayedIcons . . . . . . . 1-3
GMSCfg:ValidateForCreate . . . . . . . . . 1-65
PdmItemEms:CheckReplicaSyncStatusD . . 1-1
GMSCfg:ValidateForDelete . . . . . . . . . 1-67
PdmItemEms:ExportObjectSetDP . . . . . 1-2
GnDocDmm:GetTeamFolderForObj . . . . 1-42
PdmItemEms:FilterOtherSideObjAndRel . . 1-30
PdmItemEms:FindEquivalentLocalObject . . 1-31
I PdmItemEms:FindLocalObject . . . . . . . 1-32
Icon conventions . . . . . . . . . . . . . . . . . . . 6 PdmItemEms:GetMultipleRootObjects . . 1-37
ImportFromXMLToDbPost (Teamcenter PdmItemEms:GetRootObject . . . . . . . . 1-41
Enterprise Data Exchange) . . . . . . . . 1-43 PdmItemEms:InflateDisplayedIcons . . . . 1-3
ImportFromXMLToDbPre (Teamcenter PdmItemEms:InsertDbItem . . . . . . . . . 1-46
Enterprise Data Exchange) . . . . . . . . 1-44 PdmItemEms:MoveDbItem . . . . . . . . . 1-48
ImpRec:DeleteDbObject . . . . . . . . . . . . 1-18 PdmItemEms:RefreshDbObject . . . . . . 1-50
InflateDisplayedIcons (Teamcenter Enterprise PdmItemEms:UpdateDbObject . . . . . . . 1-57
Data Exchange) . . . . . . . . . . . . . . . . . . 1-3 PdmItemEms:ValidateForDelete . . . . . 1-67
Index-2 API Reference MT00324 L1

Index
PdmItemEms:ValidateForUpdate . . . . . 1-69 SubmitExportRequest . . . . . . . . . . . . . 1-55

PdmRoot:ExportObjectSetDP . . . . . . . . . 1-2 SubmitRequestToGS . . . . . . . . . . . . . . 1-55
PdmRoot:ExportObjectToXMLPost . . . . 1-28 Switch:ValidateForDelete . . . . . . . . . . . 1-67
PdmRoot:FindEquivalentLocalObject . . 1-31 Syntax definition conventions . . . . . . . . . . 8
PdmRoot:FindLocalObject . . . . . . . . . . 1-32
PdmRoot:GatherClassesToExportPost . . 1-33 T
PdmRoot:ImportFromXMLToDbPost . . . 1-43
PdmRoot:ImportFromXMLToDbPre . . . 1-44 TcEntReq:CreateReqObjectPost . . . . . . 1-14
PdmRoot:NotifyObjectOwnershipTransferred . . 1-48 TcEntReq:CreateReqObjectPre . . . . . . . 1-15
PdmRoot:SetDefaultValues . . . . . . . . . 1-51 TmToCRC:DoCreateRelPost . . . . . . . . . 1-22
PdmRoot:SetImportAttrsAux . . . . . . . . 1-53 TmToCRC:DoDeleteRelation . . . . . . . . 1-24
PdmRoot:UpdateObjForExportPre . . . . 1-58 TmToCRC:DoesRelClassValForDel . . . . 1-25
PdmRoot:ValidateObjForTransOwnership . . 1-70 TmToCRC:DoesRelSideValForDel . . . . . 1-26
PdmRoot:WriteClassAttributesPost . . . 1-72 TmToCRC:SetRelationDefaults . . . . . . 1-54
PdmRoot:WriteXMLAttrsPost . . . . . . . 1-74 TmToCRC:ValRelShipForObjDelete . . . 1-71
PdmRoot:WriteXMLSubElements . . . . . 1-75 TransferFormula:GetClientIDfromTrnFormula . . 1-35
ProcessDialgForSet (Teamcenter Enterprise TransferFormula:SetSessionOptValueInFormula . . 1-54
Data Exchange) . . . . . . . . . . . . . . . . . . 1-5 TransOpt:GetCustomOptions . . . . . . . . 1-36
PropagateOccurrences (Teamcenter TransOpt:InflateDisplayedName . . . . . . 1-4
Enterprise Data Exchange) . . . . . . . . 1-49 TransTrk:GenerateMessageID . . . . . . . 1-33
TransTrk:ValidateForDelete . . . . . . . . . 1-67
R
U
RefreshDbObject (Teamcenter Enterprise UpdateDbObject (Teamcenter Enterprise Data
Data Exchange) . . . . . . . . . . . . . . . . . 1-50 Exchange) . . . . . . . . . . . . . . . . . . . . . 1-57
RelationEms:DeleteDbObject . . . . . . . . 1-18 UpdateObjForExportPre . . . . . . . . . . . 1-57
RelationEms:DoObjDelAuxForRel . . . . 1-27
RelationEms:FindEquivalentLocalObject . . 1-31
RelationEms:FindLocalObject . . . . . . . 1-32 V
RelationEms:InsertDbRelation . . . . . . . 1-47 ValForUnregister (Teamcenter Enterprise
RelationEms:RefreshDbObject . . . . . . . 1-50 Data Exchange) . . . . . . . . . . . . . . . . . 1-59
RelationEms:UpdateDbObject . . . . . . . 1-57 ValidateDialgForSet (Teamcenter Enterprise
RelationEms:ValidateForCreateRel . . . . 1-66 Data Exchange) . . . . . . . . . . . . . . . . . . 1-8
RelationEms:ValidateForUpdate . . . . . 1-69 ValidateDialog (Teamcenter Enterprise Data
RelImpRc:DeleteDbObject . . . . . . . . . . 1-18 Exchange) . . . . . . . . . . . . . . . . . . . . . . 1-9
RelImpRc:DoDeleteAuxForRel . . . . . . . 1-23 ValidateExportDialog . . . . . . . . . . . . . 1-59
RelImpRc:DoObjDelAuxForRel . . . . . . . 1-27 ValidateForCheckIn (Teamcenter Enterprise
Revision conventions . . . . . . . . . . . . . . . . 6 Data Exchange) . . . . . . . . . . . . . . . . . 1-60
ValidateForCheckOut (Teamcenter Enterprise
S Data Exchange) . . . . . . . . . . . . . . . . . 1-61
ValidateForCkiToTeam (Teamcenter
SetDefaultValues . . . . . . . . . . . . . . . . 1-50 Enterprise Data Exchange) . . . . . . . . 1-62
SetDialgDefaultsForSet (Teamcenter ValidateForCkoFromTeam (Teamcenter
Enterprise Data Exchange) . . . . . . . . 1-52 Enterprise Data Exchange) . . . . . . . . 1-63
SetDialogDefaults (Teamcenter Enterprise ValidateForCopy (Teamcenter Enterprise
Data Exchange) . . . . . . . . . . . . . . . . . . 1-6 Data Exchange) . . . . . . . . . . . . . . . . . 1-64
SetImportAttrsAux . . . . . . . . . . . . . . . 1-52 ValidateForCreate (Teamcenter Enterprise
SetRelationDefaults (Teamcenter Enterprise Data Exchange) . . . . . . . . . . . . . . . . . 1-65
Data Exchange) . . . . . . . . . . . . . . . . . 1-54 ValidateForCreateRel (Teamcenter Enterprise
SetSessionOptValueInFormula . . . . . . . 1-54 Data Exchange) . . . . . . . . . . . . . . . . . 1-66
StrucBI:GetMultipleRootObjects . . . . . 1-37 ValidateForDelete (Teamcenter Enterprise
StructurEms:ValidateForCreateRel . . . 1-66 Data Exchange) . . . . . . . . . . . . . . . . . 1-67
StructurEms:ValidateForUpdate . . . . . 1-69 ValidateForRelease (Teamcenter Enterprise
Stub:FindEquivalentLocalObject . . . . . 1-31 Data Exchange) . . . . . . . . . . . . . . . . . 1-68
MT00324 L1 API Reference Index-3

Index
ValidateForUpdate (Teamcenter Enterprise WriteXMLRootTagPost . . . . . . . . . . . . 1-74

Data Exchange) . . . . . . . . . . . . . . . . . 1-69 WriteXMLSubElements . . . . . . . . . . . . 1-75
ValidateObjForTransOwnership . . . . . . 1-69 WrkImEms:GetObjectsInSeriesForOwnTransfer . . 1-38
ValRelShipForObjDelete (Teamcenter WrkImEms:GetTeamFolderForObj . . . . 1-42
Enterprise Data Exchange) . . . . . . . . 1-71 WrkImEms:InflateRequiredDynamicAttributes . . 1-45
Value conventions . . . . . . . . . . . . . . . . . . 6 WrkImEms:IsOTAllowedForImmutable . . 1-47
VewDepR:ImportFromXMLToDbPre . . . 1-44 WrkImEms:ValidateForCheckIn . . . . . . 1-60
WrkImEms:ValidateForCheckOut . . . . 1-61
W WrkImEms:ValidateForCkiToTeam . . . 1-62
WrkImEms:ValidateForCkoFromTeam . . 1-63
WriteClassAttributesPost (Teamcenter WrkImEms:ValidateForCopy . . . . . . . . 1-64
Enterprise Data Exchange) . . . . . . . . 1-72 WrkImEms:ValidateForDelete . . . . . . . 1-67
WriteSchemaHeaderPost . . . . . . . . . . . 1-72 WrkImEms:ValidateForRelease . . . . . . 1-68
WriteXMLAttrsPost . . . . . . . . . . . . . . 1-73 WrkImEms:ValidateForUpdate . . . . . . 1-69
WriteXMLEndTagPre . . . . . . . . . . . . . 1-74
Index-4 API Reference MT00324 L1

mt00324 Ems

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

mt00324 Ems

Uploaded by

Copyright:

Available Formats

Teamcenter 9.

Application Programmer’s Interface

Application Programmer’s Interface

This product is intended for use only as described in this document.

Part I: Messages and Methods

EMS Messages and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

MT00324 L1 API Reference 3

This manual describes the Integrator Toolkit Application Programming Interface

MT00324 L1 API Reference 5

Note, Caution, and Warning Icons

A warning icon identifies practices that could result in permanent loss of

Names and Values

Bold Bold font represents unvarying text or numbers within a name or

6 API Reference MT00324 L1

Command Line Entries, File Contents, and Code

The conventions are:

Monospace Monospace font represents text or numbers you enter on a

MT00324 L1 API Reference 7

Bold Bold text represents keywords. Enter keywords as shown, in either

8 API Reference MT00324 L1

Proprietary and Restricted Rights Notice

10 API Reference MT00324 L1

I Messages and Methods

EMS Messages and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

MT00324 L1 API Reference

1 EMS Messages and Methods

External Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

MT00324 L1 API Reference

Internal Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12

API Reference MT00324 L1

MT00324 L1 API Reference

API Reference MT00324 L1

MT00324 L1 API Reference

1 EMS Messages and Methods

External Trusted Messages

define trusted external prompting displaying class message

MT00324 L1 API Reference 1-1

define trusted external prompting displaying class message

1-2 API Reference MT00324 L1

MT00324 L1 API Reference 1-3

1-4 API Reference MT00324 L1

MT00324 L1 API Reference 1-5

1-6 API Reference MT00324 L1

MT00324 L1 API Reference 1-7

1-8 API Reference MT00324 L1

MT00324 L1 API Reference 1-9

1-10 API Reference MT00324 L1

define class message AttributeToIgnore

Argument In/Out Description

define class message BulkDeletePre

Arguments In/Out Description

1-12 API Reference MT00324 L1

Arguments In/Out Description

define class message CreateReqObjectPost

Arguments In/Out Description

MT00324 L1 API Reference 1-13

Arguments In/Out Description

define class message CreateReqObjectPre

Arguments In/Out Description

1-14 API Reference MT00324 L1

Arguments In/Out Description

define class message CreateRequestPost

Arguments In/Out Description