Modules
	TIE Errors

Data Structures
struct	locale_data_s

struct	ownershipChange_s

struct	stubInfo_s

struct	TIE_option_values_s

struct	TIE_output_data_s

struct	TIE_transfer_formula_s

struct	TIE_traversed_object_s

struct	TIEGSIdentityInput_s

Macros
#define	TIE_deserialize_msg "TIE_deserialize"

#define	TIE_filter_lines_to_traverse_msg "TIE_filter_lines_to_traverse"

#define	TIE_serialize_msg "TIE_serialize"

Typedefs
typedef struct locale_data_s	locale_data_t

typedef enum Object_status_in_map_e	Object_status_in_map_t

typedef struct ownershipChange_s	ownershipChange_t

typedef enum Scope_rules_import_mode_e	Scope_rules_import_mode_t

typedef struct stubInfo_s	stubInfo_t

typedef enum TIE_cfg_delta_status_e	TIE_cfg_delta_status_t

typedef enum TIE_export_status_e	TIE_export_status_t

typedef struct TIE_option_values_s	TIE_option_value_t

typedef struct TIE_output_data_s	TIE_output_data_t

typedef struct TIE_transfer_formula_s	TIE_transfer_formula_t

typedef struct TIE_traversed_object_s	TIE_traversed_object_t

typedef struct TIEGSIdentityInput_s	TIEGSIdentityInput_t

Enumerations
enum	Object_status_in_map_e { TIE_NOCOMMENT = 0, TIE_NEW, TIE_UPDATE, TIE_DELETE, TIE_FAILED, TIE_SKIPPED, TIE_REPLACED, TIE_STUBBED, TIE_OWNPASSED, TIE_OWNFAILED, TIE_DELETEFAILED, TIE_CHECKINFAILED, TIE_NOTOWNCHECKOUT, TIE_ROLLINGBACK, TIE_UNPROCESSED, TIE_INITIALIZED, TIE_NEWUNPROCESSED, TIE_PREPROCESSED, TIE_UPDATEUNPROCESSED, TIE_NEWTOBEPROCESSED, TIE_UPDATETOBEPROCESSED, TIE_REPLACESTUBWITHNEW, TIE_UPDATEWITHSITECO, TIE_UPDATEWITHOWNERSHIPCHANGE, TIE_OCCDELETE, TIE_GRMDELETE, TIE_ITEMREVDELETE, TIE_NAMEDREFDELETE, TIE_DUPLICATEGSID, TIE_OBJECTCREATEDASHELPER, TIE_COEOWNFAILED, PRIMARY_FAILED, TIE_NAMEDREFREPLACED, TIE_UNMANAGED_SKIP, TIE_UNMANAGED_NEW, TIE_UNMANAGED_UPDATE, TIE_UNMANAGED_UNKNOWN }

enum	Scope_rules_import_mode_e { UNDEFINED_MODE = 0, IGNORE_MODE = 1, OVERWRITE_MODE = 2, APPEND_MODE = 3 }

enum	TIE_cfg_delta_status_e { BL_DELTA_STATUS_SKIP, BL_DELTA_STATUS_MODIFY, BL_DELTA_STATUS_ADD, BL_DELTA_STATUS_DELETE }

enum	TIE_export_status_e { EXPORT_SUCCESS, EXPORT_SUCCESS_STUB, EXPORT_PENDING, EXPORT_PENDING_STUB, EXPORT_PENDING_TRANSFER_OWNER, EXPORT_FAIL, EXPORT_REPLICA_DELETED, EXPORT_CONVERT_TO_STUB, EXPORT_SITE_CHECKIN, EXPORT_PENDING_SITE_CHECKIN_DELETE, EXPORT_MAX_STATUS }

Functions
TIE_API int	TIE_confirm_export (tag_t targetSiteTag, const char tcGSMessageId, int n_failed_objects, tag_t failed_objects, logical commit, int n_ownership, ownershipChange_t ownership, int n_stubs, stubInfo_t **stubs)

TIE_API int	TIE_create_gsidentities (int numInput, TIEGSIdentityInput_t input, int numGSIDTags, tag_t **gsidTags)

TIE_API int	TIE_export_objects (const char tcGSMessageId, int n_objects, tag_t objects, int n_siteTags, tag_t targetSiteTags, logical synchronize, TIE_transfer_formula_t opts, TIE_output_data_t output_data)

TIE_API int	TIE_get_hashed_uid (int ownSiteId, const char hashKey, char *hashedUID)

TIE_API int	TIE_get_object_from_mesg (void tieGenMesg, tag_t objectTag)

TIE_API int	TIE_get_preconstructed_uids (int numRequestedUids, int numConstructedUids, char **constructedUids)

TIE_API int	TIE_import_objects (const char transaction_id, tag_t master_site, TIE_transfer_formula_t opts, char input_xml_file, TIE_output_data_t *output_data)

TIE_API int	TIE_traverse_objects (const char tcGSMessageId, int n_objects, tag_t objects, int n_siteTags, tag_t targetSiteTags, logical synchronize, TIE_transfer_formula_t opts, TIE_output_data_t output_data)

Detailed Description

The ITK functions in this module deal with objects of the following type:

TransferMode: The transfer mode object specifies the context of the export. It has a context string, which specifies the intent of the export and direction, which specifies the direction of transfer. Additionally, the object specifies the various Closure Rules, Filter Rules and Property Sets that describe the mode of export through reference to the specified objects.
ClosureRule: Rules for Traversal
FilterRule: Filter rules for export or import
PropertySet: Properties that are exported as user data
Session: Holds all the data that is needed for processing export or import. It mainly controls the export/import process.

Macro Definition Documentation

#define TIE_deserialize_msg "TIE_deserialize"

Definition at line 240 of file tie.h.

#define TIE_filter_lines_to_traverse_msg "TIE_filter_lines_to_traverse"

Message to register the user exit for filtering out lines to traverse.

Definition at line 245 of file tie.h.

#define TIE_serialize_msg "TIE_serialize"

Definition at line 239 of file tie.h.

Typedef Documentation

typedef struct locale_data_s locale_data_t

typedef enum Object_status_in_map_e Object_status_in_map_t

From 0 to 99 General status flags From 100 to 199 TIE Export status flags From 200 to 299 TIE Import status flags From 300 to 399 PIE Export status flags -— future From 400 to 499 PIE Import status flags -— future

typedef struct ownershipChange_s ownershipChange_t

typedef enum Scope_rules_import_mode_e Scope_rules_import_mode_t

Scope_rules_import_mode_t enum details

typedef struct stubInfo_s stubInfo_t

typedef enum TIE_cfg_delta_status_e TIE_cfg_delta_status_t

Describes the status for the BOMLines to be indexed

typedef enum TIE_export_status_e TIE_export_status_t

Enum for TIE export status

typedef struct TIE_option_values_s TIE_option_value_t

Holds a generic name-value pair of strings

typedef struct TIE_output_data_s TIE_output_data_t

TIE_output_data structure details

typedef struct TIE_transfer_formula_s TIE_transfer_formula_t

typedef struct TIE_traversed_object_s TIE_traversed_object_t

Definitions of TIE traversed results that is used by #TIE_customTraversal_msg

typedef struct TIEGSIdentityInput_s TIEGSIdentityInput_t

Enumeration Type Documentation

enum Object_status_in_map_e

From 0 to 99 General status flags From 100 to 199 TIE Export status flags From 200 to 299 TIE Import status flags From 300 to 399 PIE Export status flags -— future From 400 to 499 PIE Import status flags -— future

Enumerator
TIE_NOCOMMENT
TIE_NEW
TIE_UPDATE
TIE_DELETE
TIE_FAILED
TIE_SKIPPED
TIE_REPLACED
TIE_STUBBED
TIE_OWNPASSED
TIE_OWNFAILED
TIE_DELETEFAILED
TIE_CHECKINFAILED
TIE_NOTOWNCHECKOUT
TIE_ROLLINGBACK
TIE_UNPROCESSED
TIE_INITIALIZED
TIE_NEWUNPROCESSED
TIE_PREPROCESSED
TIE_UPDATEUNPROCESSED
TIE_NEWTOBEPROCESSED
TIE_UPDATETOBEPROCESSED
TIE_REPLACESTUBWITHNEW
TIE_UPDATEWITHSITECO
TIE_UPDATEWITHOWNERSHIPCHANGE
TIE_OCCDELETE
TIE_GRMDELETE
TIE_ITEMREVDELETE
TIE_NAMEDREFDELETE
TIE_DUPLICATEGSID
TIE_OBJECTCREATEDASHELPER
TIE_COEOWNFAILED
PRIMARY_FAILED
TIE_NAMEDREFREPLACED
TIE_UNMANAGED_SKIP
TIE_UNMANAGED_NEW
TIE_UNMANAGED_UPDATE
TIE_UNMANAGED_UNKNOWN

Definition at line 59 of file tie.h.

enum Scope_rules_import_mode_e

Scope_rules_import_mode_t enum details

Enumerator
UNDEFINED_MODE
IGNORE_MODE	Ignores already existing scope rules during import
OVERWRITE_MODE	Overwrites already existing scope rules during import
APPEND_MODE	Appends clauses to already existing closure rules during import

Definition at line 108 of file tie.h.

enum TIE_cfg_delta_status_e

Describes the status for the BOMLines to be indexed

Enumerator
BL_DELTA_STATUS_SKIP	The line will be skipped for indexing
BL_DELTA_STATUS_MODIFY	The line is modified
BL_DELTA_STATUS_ADD	The line is added
BL_DELTA_STATUS_DELETE	The line is deleted

Definition at line 119 of file tie.h.

enum TIE_export_status_e

Enum for TIE export status

Enumerator
EXPORT_SUCCESS
EXPORT_SUCCESS_STUB
EXPORT_PENDING
EXPORT_PENDING_STUB
EXPORT_PENDING_TRANSFER_OWNER
EXPORT_FAIL
EXPORT_REPLICA_DELETED
EXPORT_CONVERT_TO_STUB
EXPORT_SITE_CHECKIN
EXPORT_PENDING_SITE_CHECKIN_DELETE
EXPORT_MAX_STATUS

Definition at line 210 of file tie.h.

Function Documentation

TIE_API int TIE_confirm_export	(	tag_t	targetSiteTag,
		const char *	tcGSMessageId,
		int	n_failed_objects,
		tag_t *	failed_objects,
		logical	commit,
		int *	n_ownership,
		ownershipChange_t **	ownership,
		int *	n_stubs,
		stubInfo_t **	stubs
	)

Confirm export and failure of objects

Parameters

targetSiteTag	(I) Tag of target site
tcGSMessageId	(I) Unique id for transaction
n_failed_objects	(I) Number of objects that failed to export
failed_objects	(I) n_failed_objects Objects that failed to export
commit	(I) commit export or roll back on failure
n_ownership	(O) Number of ownership changes
ownership	(OF) n_ownership Ownership change list
n_stubs	(O) Number of stubs
stubs	(OF) n_stubs Stub replication list

TIE_API int TIE_create_gsidentities	(	int	numInput,
		TIEGSIdentityInput_t *	input,
		int *	numGSIDTags,
		tag_t **	gsidTags
	)

Create GSIdentities in bulk.

Parameters

numInput	(I) Number of GSIdentityInputs
input	(I) Array of Structures containing GSID info
numGSIDTags	(O) Number of created GSIdentity Tags
gsidTags	(OF) numGSIDTags Number of GSIdentity Tags created

TIE_API int TIE_export_objects	(	const char *	tcGSMessageId,
		int	n_objects,
		tag_t *	objects,
		int	n_siteTags,
		tag_t *	targetSiteTags,
		logical	synchronize,
		TIE_transfer_formula_t	opts,
		TIE_output_data_t *	output_data
	)

Exports a list of objects

Parameters

tcGSMessageId	(I) Unique id for transaction
n_objects	(I) Number of objects to export
objects	(I) n_objects Objects to export
n_siteTags	(I) Number of sites to export to
targetSiteTags	(I) n_siteTags Tags of target sites
synchronize	(I) Synchronize objects
opts	(I) Structure of options
output_data	(I) Output data structure

TIE_API int TIE_get_hashed_uid	(	int	ownSiteId,
		const char *	hashKey,
		char **	hashedUID
	)

Takes a hash key as input and generates a valid Teamcenter UID based on it.

Parameters

ownSiteId	(I) Site Id of Legacy system/
hashKey	(I) Hash Key
hashedUID	(OF) Valid Teamcenter UID for given hash key

TIE_API int TIE_get_object_from_mesg	(	void *	tieGenMesg,
		tag_t *	objectTag
	)

Extract information from TIE_Message_t

Parameters

tieGenMesg	(I) TIE_message_t
objectTag	(O) object tag

TIE_API int TIE_get_preconstructed_uids	(	int	numRequestedUids,
		int *	numConstructedUids,
		char ***	constructedUids
	)

Generate a number of pre-constructed Teamcenter UIDs.

Parameters

numRequestedUids	(I) Number of UIDs to construct
numConstructedUids	(O) Number of UIDs constructed
constructedUids	(OF) numConstructedUids UIDs constructed

TIE_API int TIE_import_objects	(	const char *	transaction_id,
		tag_t	master_site,
		TIE_transfer_formula_t	opts,
		char *	input_xml_file,
		TIE_output_data_t *	output_data
	)

Exports a list of objects

Parameters

transaction_id	(I) Unique id for transaction or NULL
master_site	(I) Master site or NULL
opts	(I) Structure of options
input_xml_file	(I) fms ticket for input xml file
output_data	(OF) Logfile and failedobjects file

TIE_API int TIE_traverse_objects	(	const char *	tcGSMessageId,
		int	n_objects,
		tag_t *	objects,
		int	n_siteTags,
		tag_t *	targetSiteTags,
		logical	synchronize,
		TIE_transfer_formula_t	opts,
		TIE_output_data_t *	output_data
	)

Traverse a list of objects

Parameters

tcGSMessageId	(I) Unique id for transaction
n_objects	(I) Number of objects to export
objects	(I) n_objects Objects to export
n_siteTags	(I) Number of sites to export to
targetSiteTags	(I) n_siteTags Tags of target sites
synchronize	(I) Synchronize objects
opts	(I) Structure of options
output_data	(I) Output data structure

Modules

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation