Modules
	Application Interface Web Service

	AIWS Extensions

	Application Interface

	AIWS User Data Reader/Writer

	PIE Errors

Macros
#define	CLAUSE_ATTRIBUTE_STR "ATTRIBUTE"

#define	CLAUSE_CLASS_STR "CLASS"

#define	CLAUSE_CONTENT_STR "CONTENT"

#define	CLAUSE_DELIMITERS ":."

#define	CLAUSE_FUNCTION_STR "FUNCTION"

#define	CLAUSE_OCCTYPE_STR "OCCTYPE"

#define	CLAUSE_PROPERTY_RULE_CAND_KEY_STR "CAND_KEY"

#define	CLAUSE_PROPERTY_RULE_DO_STR "DO"

#define	CLAUSE_PROPERTY_RULE_SKIP_GRM_STR "SKIP_GRM"

#define	CLAUSE_PROPERTY_RULE_SKIP_STR "SKIP"

#define	CLAUSE_PROPERTY_RULE_STUB_KEY_STR "STUB_KEY"

#define	CLAUSE_PROPERTY_STR "PROPERTY"

#define	CLAUSE_REFBY_STR "REFBY"

#define	CLAUSE_RELATION_STR "RELATION"

#define	CLAUSE_RELATIONP2S_STR "RELATIONP2S"

#define	CLAUSE_RELATIONS2P_STR "RELATIONS2P"

#define	CLAUSE_TYPE_STR "TYPE"

#define	NOPROCESS_TRAVERSE_DIRECTIVE "TRAVERSE_NO_PROCESS"

#define	PIE_COLON_DELIMITER ":"

#define	PIE_context_size_c 240

#define	PIE_desc_size_c 240

#define	PIE_DOT_DELIMITER "."

#define	PIE_name_size_c 32

#define	PIE_TcPLMXML_schema PIE_TcXML_schema

#define	PIE_WILD_CARD_ASTERIX "*"

#define	PROCESS_AND_TRAVERSE_DIRECTIVE "TRAVERSE_AND_PROCESS"

#define	PROCESS_DIRECTIVE "PROCESS"

#define	TRANSIENT_VOLUME_ROOTDIR "Transient_Volume_RootDir"

Typedefs
typedef enum PIE_action_e	PIE_action_t

typedef enum PIE_connection_type_e	PIE_connection_type_t

typedef enum PIE_direction_e	PIE_direction_t

typedef enum PIE_object_status_in_map_e	PIE_object_status_in_map_t

typedef enum PIE_prop_rule_type_e	PIE_prop_rule_type_t

typedef enum PIE_rule_type_e	PIE_rule_type_t

typedef enum PIE_schema_e	PIE_schema_t

typedef enum PIE_scope_e	PIE_scope_t

typedef enum PIE_transferoptionset_scope_e	PIE_transferoptionset_scope_t

typedef enum PIE_type_e	PIE_type_t

typedef enum PIE_user_exits_type_e	PIE_user_exits_type_t

Enumerations
enum	PIE_action_e { PIE_PREACTION = 0, PIE_DURINGACTION = 1, PIE_POSTACTION = 2 }

enum	PIE_connection_type_e { PIE_property = 0, PIE_attribute = 1, PIE_relation_primary = 2, PIE_relation_secondary = 3, PIE_referenced_by = 4, PIE_all = 5, PIE_occurrence_type = 6, PIE_content = 7, PIE_function = 8 }

enum	PIE_direction_e { PIE_teamcenter2PLMXML = 0, PIE_PLMXML2teamcenter = 1, PIE_direction_both = 2 }

enum	PIE_object_status_in_map_e { PIE_NOCOMMENT = 0, PIE_NEW = 1, PIE_MOD = 2, PIE_PROC_NO_TRAV = 3, PIE_PROC_AGAIN = 4, PIE_DS_REVISED = 5, PIE_DS_ADD_TO_IC = 6, PIE_DS_TO_VERSION = 7, PIE_BOMLine_editable = 8, PIE_POMCLASS = 1024, PIE_DEL = 10, PIE_INCOMPLETE = 11 }

enum	PIE_prop_rule_type_e { PIE_prop_do = 0, PIE_prop_skip = 1, PIE_prop_stub_key = 2, PIE_prop_cand_key = 3 }

enum	PIE_rule_type_e { PIE_skip = 1, PIE_process = 2, PIE_travers_no_process = 4, PIE_travers_and_process = 6, PIE_skip_grm = 32 }

enum	PIE_schema_e { PIE_ALL_schema = 2, PIE_PLMXML_schema = 0, PIE_TcXML_schema = 1 }

enum	PIE_scope_e { PIE_TEAMCENTER = 0, PIE_PLMXML = 1 }

enum	PIE_transferoptionset_scope_e { PIE_transferoptionset_private = 0, PIE_transferoptionset_public = 1, PIE_transferoptionset_all = 2 }

enum	PIE_type_e { PIE_class = 0, PIE_type = 1 }

enum	PIE_user_exits_type_e { PIE_internal_user_exits = 0, PIE_external_user_exits = 1 }

Functions
PIE_API int	PIE__compare_set_visitor (tag_t diff_set, int depth, void *user_data)

PIE_API int	PIE_closure_add_rule_clause (tag_t closure_tag, PIE_type_t p_class_or_type, const char p_name, PIE_connection_type_t c_type, const char c_name, const char prop_name, PIE_type_t s_class_or_type, const char s_name, PIE_rule_type_t rule_type)

PIE_API int	PIE_closure_get_rule_clause (tag_t closure_tag, int index, PIE_type_t p_class_or_type, char p_name, PIE_connection_type_t c_type, char c_name, char prop_name, PIE_type_t s_class_or_type, char s_name, PIE_rule_type_t rule_type)

PIE_API int	PIE_closure_set_rule_clause (tag_t closure_tag, int index, PIE_type_t p_class_or_type, const char p_name, PIE_connection_type_t c_type, const char c_name, const char prop_name, PIE_type_t s_class_or_type, const char s_name, PIE_rule_type_t rule_type)

PIE_API int	PIE_create_closure_rules (const char name[PIE_name_size_c+1], const char desc[PIE_desc_size_c+1], PIE_scope_t scope, tag_t *closure_tag)

PIE_API int	PIE_create_closure_rules2 (const char name, const char desc, PIE_scope_t scope, tag_t *closure_tag)

PIE_API int	PIE_create_filter (const char name[PIE_name_size_c+1], const char desc[PIE_desc_size_c+1], PIE_scope_t scope, tag_t *filter)

PIE_API int	PIE_create_filter2 (const char name, const char desc, PIE_scope_t scope, tag_t *filter)

PIE_API int	PIE_create_transfer_mode_instance (const char transfer_mode_name[WSO_name_size_c+1], const char transfer_mode_desc[WSO_desc_size_c+1], const char context_string[PIE_context_size_c+1], tag_t *transfer_mode)

PIE_API int	PIE_create_transfer_mode_instance2 (const char transfer_mode_name, const char transfer_mode_desc, const char context_string, tag_t transfer_mode)

PIE_API int	PIE_describe_closure_rule (tag_t closure_tag, char name[PIE_name_size_c+1], char desc[PIE_desc_size_c+1], PIE_scope_t scope, int n_clauses)

PIE_API int	PIE_describe_closure_rule2 (tag_t closure_tag, char name, char desc, PIE_scope_t scope, int n_clauses)

PIE_API int	PIE_describe_filter (tag_t filter_tag, char name[PIE_name_size_c+1], char desc[PIE_desc_size_c+1], PIE_scope_t scope, int n_clauses)

PIE_API int	PIE_describe_filter2 (tag_t filter_tag, char name, char desc, PIE_scope_t scope, int n_clauses)

PIE_API int	PIE_extent_transfer_modes (int n_transfer_modes, tag_t *transfer_modes)

PIE_API int	PIE_filter_add_clause (tag_t filter, PIE_type_t type_or_class, const char p_name, const char filter_name)

PIE_API int	PIE_filter_get_clause (tag_t filter, int index, PIE_type_t type_or_class, char p_name, char *filter_name)

PIE_API int	PIE_find_closure_rules (const char name[PIE_name_size_c+1], PIE_scope_t scope, int n_closure_tags, tag_t *closure_tags)

PIE_API int	PIE_find_closure_rules2 (const char name, PIE_scope_t scope, int n_closure_tags, tag_t **closure_tags)

PIE_API int	PIE_find_filter (const char name[PIE_name_size_c+1], PIE_scope_t scope, int n_filter_tags, tag_t *filter_tags)

PIE_API int	PIE_find_filter2 (const char name, PIE_scope_t scope, int n_filter_tags, tag_t **filter_tags)

PIE_API int	PIE_find_object_by_appref (char appuid, char appl, char site, char ver, int count, tag_t *found)

PIE_API int	PIE_find_transfer_mode (const char transfer_mode_name[WSO_name_size_c+1], const char context_string[PIE_context_size_c+1], int n_transfer_mode_tags, tag_t *transfer_mode_tags)

PIE_API int	PIE_find_transfer_mode2 (const char transfer_mode_name, const char context_string, int n_transfer_mode_tags, tag_t *transfer_mode_tags)

PIE_API int	PIE_transfer_mode_get_action_list (tag_t transfer_mode, int n_action_list_objs, tag_t *action_list_objs)

PIE_API int	PIE_transfer_mode_get_closures (tag_t transfer_mode, tag_t *closure)

PIE_API int	PIE_transfer_mode_get_config_objs (tag_t transfer_mode, int n_config_objs, tag_t *config_objs)

PIE_API int	PIE_transfer_mode_get_context_string (tag_t transfer_mode, char context_string[PIE_context_size_c+1])

PIE_API int	PIE_transfer_mode_get_context_string2 (tag_t transfer_mode, char **context_string)

PIE_API int	PIE_transfer_mode_get_direction (tag_t transfer_mode, PIE_direction_t *direction)

PIE_API int	PIE_transfer_mode_get_filters (tag_t transfer_mode, tag_t *filter)

PIE_API int	PIE_transfer_mode_get_incremental (tag_t transfer_mode, logical *incremental)

PIE_API int	PIE_transfer_mode_get_multisite (tag_t transfer_mode, logical *multisite)

PIE_API int	PIE_transfer_mode_get_prop_set (tag_t transfer_mode, tag_t *prop_set)

PIE_API int	PIE_transfer_mode_get_schema_format (tag_t transfer_mode, PIE_schema_t *schema_format)

PIE_API int	PIE_transfer_mode_get_xslt (tag_t transfer_mode, int n_files, tag_t *xslt_files)

PIE_API int	PIE_transfer_mode_load_defaults (tag_t transfer_mode)

PIE_API int	PIE_transfer_mode_remove_xslt (tag_t transfer_mode, tag_t xslt_file)

PIE_API int	PIE_transfer_mode_set_action_list (tag_t transfer_mode, int n_action_list_objs, tag_t *action_list_objs)

PIE_API int	PIE_transfer_mode_set_closures (tag_t transfer_mode, tag_t closure)

PIE_API int	PIE_transfer_mode_set_config_objs (tag_t transfer_mode, int n_config_objs, tag_t *config_objs)

PIE_API int	PIE_transfer_mode_set_context_string (tag_t transfer_mode, const char context_string[PIE_context_size_c+1])

PIE_API int	PIE_transfer_mode_set_context_string2 (tag_t transfer_mode, const char *context_string)

PIE_API int	PIE_transfer_mode_set_direction (tag_t transfer_mode, PIE_direction_t direction)

PIE_API int	PIE_transfer_mode_set_filters (tag_t transfer_mode, tag_t filter)

PIE_API int	PIE_transfer_mode_set_incremental (tag_t transfer_mode, logical incremental)

PIE_API int	PIE_transfer_mode_set_multisite (tag_t transfer_mode, logical multisite)

PIE_API int	PIE_transfer_mode_set_prop_set (tag_t transfer_mode, tag_t prop_set)

PIE_API int	PIE_transfer_mode_set_schema_format (tag_t transfer_mode, PIE_schema_t schema_format)

PIE_API int	PIE_transfer_mode_set_xslt (tag_t transfer_mode, int n_files, tag_t *xslt_files)

Action Rule Calls
PIE_API int	PIE_create_action (const char name[PIE_name_size_c+1], const char desc[PIE_desc_size_c+1], PIE_scope_t scope, PIE_action_t type, const char actionName, tag_t action)

PIE_API int	PIE_create_action2 (const char name, const char desc, PIE_scope_t scope, PIE_action_t type, const char actionName, tag_t action)

PIE_API int	PIE_find_action (const char name[PIE_name_size_c+1], PIE_scope_t scope, int n_action_tags, tag_t *action_tags)

PIE_API int	PIE_find_action2 (const char name, PIE_scope_t scope, int n_action_tags, tag_t **action_tags)

PIE_API int	PIE_describe_action (tag_t action_tag, char name[PIE_name_size_c+1], char desc[PIE_desc_size_c+1], PIE_scope_t scope, PIE_action_t type, char **actionName)

PIE_API int	PIE_describe_action2 (tag_t action_tag, char name, char desc, PIE_scope_t scope, PIE_action_t type, char **actionName)

PIE_API int	PIE_action_set_func_name (tag_t action, const char *func_name)

PIE_API int	PIE_action_get_func_name (tag_t action, char **func_name)

Property Set Calls
PIE_API int	PIE_create_prop_set (const char name[PIE_name_size_c+1], const char desc[PIE_desc_size_c+1], PIE_scope_t scope, tag_t *prop_set)

PIE_API int	PIE_create_prop_set2 (const char name, const char desc, PIE_scope_t scope, tag_t *prop_set)

PIE_API int	PIE_find_prop_set (const char name[PIE_name_size_c+1], PIE_scope_t scope, int n_propset_tags, tag_t *propset_tags)

PIE_API int	PIE_find_prop_set2 (const char name, PIE_scope_t scope, int n_propset_tags, tag_t **propset_tags)

PIE_API int	PIE_prop_add_clause (tag_t prop_set, PIE_type_t type_or_class, const char p_name, PIE_connection_type_t prop_or_attr, const char a_name, PIE_prop_rule_type_t rule_type)

PIE_API int	PIE_describe_prop_set (tag_t prop_set, char name[PIE_name_size_c+1], char desc[PIE_desc_size_c+1], PIE_scope_t scope, int n_clauses)

PIE_API int	PIE_describe_prop_set2 (tag_t prop_set, char name, char desc, PIE_scope_t scope, int n_clauses)

PIE_API int	PIE_prop_get_clause (tag_t prop_set, int index, PIE_type_t type_or_class, char p_name, PIE_connection_type_t prop_or_attr, char *a_name, PIE_prop_rule_type_t rule_type)

Option Set Related APIs
PIE_API int	PIE_find_transfer_option_set (const char transfer_option_set_name, int num_transfer_option_set_tags, tag_t **transfer_option_set_tags)

PIE_API int	PIE_get_available_transfer_option_sets (tag_t user, tag_t group, tag_t role, int n_sites, tag_t sites, logical is_push, logical is_export, int n_optionsets, tag_t **option_set_objs)

PIE_API int	PIE_describe_option_set (tag_t option_set_tag, char option_set_name[WSO_name_size_c+1], char option_set_description[WSO_desc_size_c+1], tag_t transfermode, char transfermode_name[WSO_name_size_c+1], tag_t site, int n_options, char option_names, char option_display_names, char option_values, char option_descriptions, char option_group_names, logical option_read_only_flags)

PIE_API int	PIE_describe_option_set2 (tag_t option_set_tag, char option_set_name, char option_set_description, tag_t transfermode, char transfermode_name, tag_t site, int n_options, char option_names, char option_display_names, char option_values, char option_descriptions, char option_group_names, logical option_read_only_flags)

PIE Session calls
PIE_API int	PIE_create_session (tag_t *session)

PIE_API int	PIE_create_session_for_ai (tag_t request, tag_t *session)

PIE_API int	PIE_session_set_file (tag_t session, const char *file_name)

PIE_API int	PIE_session_ask_file (tag_t session, const char **file_name)

PIE_API int	PIE_session_set_log_file (tag_t session, const char *file_name)

PIE_API int	PIE_session_ask_transfer_mode (tag_t session, tag_t *transfer_mode)

PIE_API int	PIE_session_set_transfer_mode (tag_t session, tag_t transfer_mode)

PIE_API int	PIE_session_set_revision_rule (tag_t session, tag_t revision_rule)

PIE_API int	PIE_session_export_objects (tag_t session, int n_objs, tag_t *obj_list)

PIE_API int	PIE_session_get_target_pathname (tag_t session, char **pathname)

PIE_API int	PIE_session_set_target_pathname (tag_t session, char *pathname)

PIE_API int	PIE_session_get_incremental_change (tag_t session, tag_t *incremental_change)

PIE_API int	PIE_session_set_incremental_change (tag_t session, tag_t incremental_change)

PIE_API int	PIE_session_set_edit_targets (tag_t session, int num_tags, tag_t *tags_allowed_to_edit)

PIE_API int	PIE_session_set_ic_exclusion_list (tag_t session, int num_tags, tag_t *ic_tags_to_exclude)

PIE_API int	PIE_session_import_objects (tag_t session, logical dry_run, int n_objs, tag_t *obj_list)

PIE_API int	PIE_session_get_rule_types (tag_t session, int n_types, char **typeNames)

PIE_API int	PIE_session_get_log_lines (tag_t session, int n_lines, char **log_lines)

PIE_API int	PIE_session_get_errors (tag_t session, int n_errors, tag_t error_objs, int *error_codes)

PIE_API int	PIE_session_get_import_errors (tag_t session, int n_errors, char error_ids, int error_codes)

PIE_API int	PIE_delete_session (tag_t session)

PIE_API int	PIE_session_add_info (tag_t session, int n_strings, char titles, char values)

PIE_API int	PIE_session_ask_info (tag_t session, int n_strings, char titles, char *values)

PIE_API int	PIE_session_set_xslt (tag_t session, logical override, int n_files, tag_t *xslt_files)

PIE_API int	PIE_session_get_xslt (tag_t session, logical override, int n_files, tag_t **xslt_files)

PIE_API int	PIE_session_get_user_xslt_file (tag_t session, char **user_xslt_fname)

PIE_API int	PIE_session_set_user_xslt_file (tag_t session, const char *user_xslt_fname)

PIE_API int	PIE_session_get_export_locales (tag_t session, int exportlocaleCount, char **exportLocales)

PIE_API int	PIE_session_set_export_locales (tag_t session, const int exportlocaleCount, char **exportLocales)

PIE_API int	PIE_session_get_plmxml_document (tag_t session, void **plmxmlDoc)

PIE_API int	PIE_session_update_processed_object (tag_t session, tag_t obj, void *plmxmlObj, int failCode)

PIE_API int	PIE_session_get_processed_plmxml_object (tag_t session, tag_t obj, void *plmxmlObj, int failCode)

PIE_API int	PIE_session_get_processed_tc_object (tag_t session, void plmxmlObj, tag_t obj, int *failCode)

PIE Delta Calls
PIE_API int	PIE_create_delta_info (tag_t *delta_info)

PIE_API int	PIE_create_bom_delta_info (tag_t *piebomdeltainfo)

PIE_API int	PIE_add_delta_objects (tag_t delta_info, int n_objs, tag_t *objs)

PIE_API int	PIE_get_delta_adds (tag_t delta_info, int n_objs, tag_t *added_objs)

PIE_API int	PIE_get_delta_deletes (tag_t delta_info, int n_objs, tag_t *deleted_objs)

PIE_API int	PIE_get_delta_modifications (tag_t delta_info, int n_objs, tag_t *modified_objs)

PIE_API int	PIE_create_delta_session (tag_t old_xml_file, char targetPathName, tag_t session)

PIE_API int	PIE_merge_delta_to_base (tag_t session, tag_t *merged_xml_file)

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 CLAUSE_ATTRIBUTE_STR "ATTRIBUTE"

Definition at line 54 of file pie.h.

#define CLAUSE_CLASS_STR "CLASS"

Definition at line 52 of file pie.h.

#define CLAUSE_CONTENT_STR "CONTENT"

Definition at line 60 of file pie.h.

#define CLAUSE_DELIMITERS ":."

Definition at line 46 of file pie.h.

#define CLAUSE_FUNCTION_STR "FUNCTION"

Definition at line 61 of file pie.h.

#define CLAUSE_OCCTYPE_STR "OCCTYPE"

Definition at line 59 of file pie.h.

#define CLAUSE_PROPERTY_RULE_CAND_KEY_STR "CAND_KEY"

Rule String CAND_KEY for Property set

Definition at line 75 of file pie.h.

#define CLAUSE_PROPERTY_RULE_DO_STR "DO"

Definition at line 67 of file pie.h.

#define CLAUSE_PROPERTY_RULE_SKIP_GRM_STR "SKIP_GRM"

Definition at line 69 of file pie.h.

#define CLAUSE_PROPERTY_RULE_SKIP_STR "SKIP"

Definition at line 68 of file pie.h.

#define CLAUSE_PROPERTY_RULE_STUB_KEY_STR "STUB_KEY"

Rule String STUB_KEY for Property set

Definition at line 72 of file pie.h.

#define CLAUSE_PROPERTY_STR "PROPERTY"

Definition at line 53 of file pie.h.

#define CLAUSE_REFBY_STR "REFBY"

Definition at line 58 of file pie.h.

#define CLAUSE_RELATION_STR "RELATION"

Definition at line 55 of file pie.h.

#define CLAUSE_RELATIONP2S_STR "RELATIONP2S"

Definition at line 56 of file pie.h.

#define CLAUSE_RELATIONS2P_STR "RELATIONS2P"

Definition at line 57 of file pie.h.

#define CLAUSE_TYPE_STR "TYPE"

Definition at line 51 of file pie.h.

#define NOPROCESS_TRAVERSE_DIRECTIVE "TRAVERSE_NO_PROCESS"

Definition at line 64 of file pie.h.

#define PIE_COLON_DELIMITER ":"

Definition at line 47 of file pie.h.

#define PIE_context_size_c 240

Definition at line 44 of file pie.h.

#define PIE_desc_size_c 240

Definition at line 45 of file pie.h.

#define PIE_DOT_DELIMITER "."

Definition at line 48 of file pie.h.

#define PIE_name_size_c 32

Definition at line 43 of file pie.h.

#define PIE_TcPLMXML_schema PIE_TcXML_schema

Note: : The recommendation on enum for TcXML schema format is to use PIE_TcXML_schema. However, to support existing usages, the following defined symbol is required

Definition at line 155 of file pie.h.

#define PIE_WILD_CARD_ASTERIX "*"

Definition at line 49 of file pie.h.

#define PROCESS_AND_TRAVERSE_DIRECTIVE "TRAVERSE_AND_PROCESS"

Definition at line 65 of file pie.h.

#define PROCESS_DIRECTIVE "PROCESS"

Definition at line 63 of file pie.h.

#define TRANSIENT_VOLUME_ROOTDIR "Transient_Volume_RootDir"

Definition at line 77 of file pie.h.

Typedef Documentation

typedef enum PIE_action_e PIE_action_t

typedef enum PIE_connection_type_e PIE_connection_type_t

Enum for type of relation (or reference) to traverse in closure rule

typedef enum PIE_direction_e PIE_direction_t

Enum for translation direction

typedef enum PIE_object_status_in_map_e PIE_object_status_in_map_t

This enum is used to set the status of object that is in the object map.

typedef enum PIE_prop_rule_type_e PIE_prop_rule_type_t

Enum for rule type in a property set

typedef enum PIE_rule_type_e PIE_rule_type_t

Enum for rule type in closure rule

typedef enum PIE_schema_e PIE_schema_t

Enum for Schema Format Specification

typedef enum PIE_scope_e PIE_scope_t

Enum for translation scope

typedef enum PIE_transferoptionset_scope_e PIE_transferoptionset_scope_t

Enum for spcifying scope of transferoptionset

typedef enum PIE_type_e PIE_type_t

Enum for formulating Closure, Filter and PropSet Clauses

typedef enum PIE_user_exits_type_e PIE_user_exits_type_t

This enum is used to set the scope of user exits

Enumeration Type Documentation

enum PIE_action_e

Enumerator
PIE_PREACTION
PIE_DURINGACTION
PIE_POSTACTION

Definition at line 176 of file pie.h.

enum PIE_connection_type_e

Enum for type of relation (or reference) to traverse in closure rule

Enumerator
PIE_property
PIE_attribute
PIE_relation_primary
PIE_relation_secondary
PIE_referenced_by
PIE_all
PIE_occurrence_type
PIE_content	for plmxml input traversals...
PIE_function

Definition at line 91 of file pie.h.

enum PIE_direction_e

Enum for translation direction

Enumerator
PIE_teamcenter2PLMXML
PIE_PLMXML2teamcenter
PIE_direction_both

Definition at line 135 of file pie.h.

enum PIE_object_status_in_map_e

This enum is used to set the status of object that is in the object map.

Enumerator
PIE_NOCOMMENT	This is used for initialization.
PIE_NEW	This is used to specify that current object is newly created.
PIE_MOD	This is used to specify that current object exists in DB and has been modified.
PIE_PROC_NO_TRAV	This is used to specify that current object has been processed and it will not be traversed.
PIE_PROC_AGAIN	This is used to specify that even though this object is in the map, it was not processed fully. So process it again.
PIE_DS_REVISED	This is used to specify that current version of dataset is not lower than the latest.
PIE_DS_ADD_TO_IC	Under some circumstances we must add a dataset to the IC if the existing dataset has named references this is done for specific integrations.
PIE_DS_TO_VERSION	Add files to specific version.
PIE_BOMLine_editable	Checking whether BOM line is editable or not in JT export.
PIE_POMCLASS	The processed object is POMClass, not object instance.
PIE_DEL	Mark for object deleted, like delta delete.
PIE_INCOMPLETE	The object is being processed.This is used for specify that the object will be traversed while it is being processed.

Definition at line 186 of file pie.h.

enum PIE_prop_rule_type_e

Enum for rule type in a property set

Enumerator
PIE_prop_do	Rule DO
PIE_prop_skip	Rule SKIP
PIE_prop_stub_key	Rule STUB_KEY
PIE_prop_cand_key	Rule CAND_KEY

Definition at line 124 of file pie.h.

enum PIE_rule_type_e

Enum for rule type in closure rule

Enumerator
PIE_skip
PIE_process
PIE_travers_no_process
PIE_travers_and_process
PIE_skip_grm

Definition at line 112 of file pie.h.

enum PIE_schema_e

Enum for Schema Format Specification

Enumerator
PIE_ALL_schema
PIE_PLMXML_schema
PIE_TcXML_schema

Definition at line 145 of file pie.h.

enum PIE_scope_e

Enum for translation scope

Enumerator
PIE_TEAMCENTER
PIE_PLMXML

Definition at line 170 of file pie.h.

enum PIE_transferoptionset_scope_e

Enum for spcifying scope of transferoptionset

Enumerator
PIE_transferoptionset_private
PIE_transferoptionset_public
PIE_transferoptionset_all

Definition at line 160 of file pie.h.

enum PIE_type_e

Enum for formulating Closure, Filter and PropSet Clauses

Enumerator
PIE_class
PIE_type

Definition at line 82 of file pie.h.

enum PIE_user_exits_type_e

This enum is used to set the scope of user exits

Enumerator
PIE_internal_user_exits
PIE_external_user_exits

Definition at line 211 of file pie.h.

Function Documentation

PIE_API int PIE__compare_set_visitor	(	tag_t	diff_set,
		int	depth,
		void *	user_data
	)

For AutoTest

PIE_API int PIE_action_get_func_name	(	tag_t	action,
		char **	func_name
	)

Parameters

action	(I)
func_name	(OF)

PIE_API int PIE_action_set_func_name	(	tag_t	action,
		const char *	func_name
	)

Parameters

action	(I)
func_name	(I)

PIE_API int PIE_add_delta_objects	(	tag_t	delta_info,
		int	n_objs,
		tag_t *	objs
	)

Parameters

delta_info	(I)
n_objs	(I)
objs	(I)

PIE_API int PIE_closure_add_rule_clause	(	tag_t	closure_tag,
		PIE_type_t	p_class_or_type,
		const char *	p_name,
		PIE_connection_type_t	c_type,
		const char *	c_name,
		const char *	prop_name,
		PIE_type_t	s_class_or_type,
		const char *	s_name,
		PIE_rule_type_t	rule_type
	)

Parameters

closure_tag	(I) Closure Rule Tag
p_class_or_type	(I) Whether the primary object is specified through Type or Class
p_name	(I) Class or Type name of the primary object
c_type	(I) The type of connectivity between Primary and Secondary Objects
c_name	(I) Name of the connectivity/relation between Primary and Secondary Objects
prop_name	(I) Represents the attribute/property name, when the relation is ATTRIBUTE/PROPERTY
s_class_or_type	(I) Whether the secondary object is specified through Type or Class
s_name	(I) The name of the class or type of the secondary object
rule_type	(I) The Directive specification

PIE_API int PIE_closure_get_rule_clause	(	tag_t	closure_tag,
		int	index,
		PIE_type_t *	p_class_or_type,
		char **	p_name,
		PIE_connection_type_t *	c_type,
		char **	c_name,
		char **	prop_name,
		PIE_type_t *	s_class_or_type,
		char **	s_name,
		PIE_rule_type_t *	rule_type
	)

Parameters

closure_tag	(I) Closure Rule tag
index	(I) Index of the clause
p_class_or_type	(O) Whether the primary object is specified through Type or Class
p_name	(OF) Class or Type name of the primary object
c_type	(O) The type of connectivity between Primary and Secondary Objects
c_name	(OF) Name of the connectivity/relation between Primary and Secondary Objects
prop_name	(OF) Represents the attribute/property name, when the relation is ATTRIBUTE/PROPERTY
s_class_or_type	(O) Whether the secondary object is specified through Type or Class
s_name	(OF) The name of the class or type of the secondary object
rule_type	(O) The Directive specification

PIE_API int PIE_closure_set_rule_clause	(	tag_t	closure_tag,
		int	index,
		PIE_type_t	p_class_or_type,
		const char *	p_name,
		PIE_connection_type_t	c_type,
		const char *	c_name,
		const char *	prop_name,
		PIE_type_t	s_class_or_type,
		const char *	s_name,
		PIE_rule_type_t	rule_type
	)

Parameters

closure_tag	(I) Closure Rule tag
index	(I) Index of the clause
p_class_or_type	(I) Whether the primary object is specified through Type or Class
p_name	(I) Class or Type name of the primary object
c_type	(I) The type of connectivity between Primary and Secondary Objects
c_name	(I) Name of the connectivity/relation between Primary and Secondary Objects
prop_name	(I) Represents the attribute/property name, when the relation is ATTRIBUTE/PROPERTY
s_class_or_type	(I) Whether the secondary object is specified through Type or Class
s_name	(I) The name of the class or type of the secondary object
rule_type	(I) The Directive specification

PIE_API int PIE_create_action	(	const char	name[PIE_name_size_c+1],
		const char	desc[PIE_desc_size_c+1],
		PIE_scope_t	scope,
		PIE_action_t	type,
		const char *	actionName,
		tag_t *	action
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_create_action2

Parameters

name	(I)
desc	(I)
scope	(I)
type	(I)
actionName	(I)
action	(O)

PIE_API int PIE_create_action2	(	const char *	name,
		const char *	desc,
		PIE_scope_t	scope,
		PIE_action_t	type,
		const char *	actionName,
		tag_t *	action
	)

Parameters

name	(I)
desc	(I)
scope	(I)
type	(I)
actionName	(I)
action	(O)

PIE_API int PIE_create_bom_delta_info ( tag_t * piebomdeltainfo )

Parameters

piebomdeltainfo (O)

PIE_API int PIE_create_closure_rules	(	const char	name[PIE_name_size_c+1],
		const char	desc[PIE_desc_size_c+1],
		PIE_scope_t	scope,
		tag_t *	closure_tag
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_create_closure_rules2

Parameters

name	(I) Closure Rule Name
desc	(I) Closure Rule Description
scope	(I) Scope of Closure Rule
closure_tag	(O) Closure Rule tag

PIE_API int PIE_create_closure_rules2	(	const char *	name,
		const char *	desc,
		PIE_scope_t	scope,
		tag_t *	closure_tag
	)

Parameters

name	(I) Closure Rule Name
desc	(I) Closure Rule Description
scope	(I) Scope of Closure Rule
closure_tag	(O) Closure Rule tag

PIE_API int PIE_create_delta_info ( tag_t * delta_info )

Parameters

delta_info (O)

PIE_API int PIE_create_delta_session	(	tag_t	old_xml_file,
		char *	targetPathName,
		tag_t *	session
	)

Parameters

old_xml_file	(I)
targetPathName	(I)
session	(O)

PIE_API int PIE_create_filter	(	const char	name[PIE_name_size_c+1],
		const char	desc[PIE_desc_size_c+1],
		PIE_scope_t	scope,
		tag_t *	filter
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_create_filter2

Parameters

name	(I) Filter Name
desc	(I) Description of the Filter
scope	(I) Scope
filter	(O) Filter tag

PIE_API int PIE_create_filter2	(	const char *	name,
		const char *	desc,
		PIE_scope_t	scope,
		tag_t *	filter
	)

Parameters

name	(I) Filter Name
desc	(I) Description of the Filter
scope	(I) Scope
filter	(O) Filter tag

PIE_API int PIE_create_prop_set	(	const char	name[PIE_name_size_c+1],
		const char	desc[PIE_desc_size_c+1],
		PIE_scope_t	scope,
		tag_t *	prop_set
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_create_prop_set2

Parameters

name	(I) Name of Property Set
desc	(I) Description of the Property set
scope	(I) Scope
prop_set	(O) Property Set tag

PIE_API int PIE_create_prop_set2	(	const char *	name,
		const char *	desc,
		PIE_scope_t	scope,
		tag_t *	prop_set
	)

Parameters

name	(I) Name of Property Set
desc	(I) Description of the Property set
scope	(I) Scope
prop_set	(O) Property Set tag

PIE_API int PIE_create_session ( tag_t * session )

Parameters

session (O) The session tag

PIE_API int PIE_create_session_for_ai	(	tag_t	request,
		tag_t *	session
	)

Parameters

request	(I)
session	(O)

PIE_API int PIE_create_transfer_mode_instance	(	const char	transfer_mode_name[WSO_name_size_c+1],
		const char	transfer_mode_desc[WSO_desc_size_c+1],
		const char	context_string[PIE_context_size_c+1],
		tag_t *	transfer_mode
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_find_transfer_mode2

Parameters

transfer_mode_name	(I) Name of Transfer Mode
transfer_mode_desc	(I) Description of Transfer Mode
context_string	(I) Input variable indicating the context string
transfer_mode	(O) Output Transfer Mode tag

PIE_API int PIE_create_transfer_mode_instance2	(	const char *	transfer_mode_name,
		const char *	transfer_mode_desc,
		const char *	context_string,
		tag_t *	transfer_mode
	)

Parameters

transfer_mode_name	(I) Name of Transfer Mode
transfer_mode_desc	(I) Description of Transfer Mode
context_string	(I) Input variable indicating the context string
transfer_mode	(O) Output Transfer Mode tag

PIE_API int PIE_delete_session ( tag_t session )

Parameters

session (I) Session tag

PIE_API int PIE_describe_action	(	tag_t	action_tag,
		char	name[PIE_name_size_c+1],
		char	desc[PIE_desc_size_c+1],
		PIE_scope_t *	scope,
		PIE_action_t *	type,
		char **	actionName
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_describe_action2

Parameters

action_tag	(I)
name	(O)
desc	(O)
scope	(O)
type	(O)
actionName	(OF)

PIE_API int PIE_describe_action2	(	tag_t	action_tag,
		char **	name,
		char **	desc,
		PIE_scope_t *	scope,
		PIE_action_t *	type,
		char **	actionName
	)

Parameters

action_tag	(I)
name	(OF)
desc	(OF)
scope	(O)
type	(O)
actionName	(OF)

PIE_API int PIE_describe_closure_rule	(	tag_t	closure_tag,
		char	name[PIE_name_size_c+1],
		char	desc[PIE_desc_size_c+1],
		PIE_scope_t *	scope,
		int *	n_clauses
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_describe_closure_rule2

Parameters

closure_tag	(I) Closure Rule tag
name	(O) Closure Rule Name
desc	(O) Closure Rule Description
scope	(O) Scope of Closure rule
n_clauses	(O) Number of clauses

PIE_API int PIE_describe_closure_rule2	(	tag_t	closure_tag,
		char **	name,
		char **	desc,
		PIE_scope_t *	scope,
		int *	n_clauses
	)

Parameters

closure_tag	(I) Closure Rule tag
name	(OF) Closure Rule Name
desc	(OF) Closure Rule Description
scope	(O) Scope of Closure rule
n_clauses	(O) Number of clauses

PIE_API int PIE_describe_filter	(	tag_t	filter_tag,
		char	name[PIE_name_size_c+1],
		char	desc[PIE_desc_size_c+1],
		PIE_scope_t *	scope,
		int *	n_clauses
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_describe_filter2

Parameters

filter_tag	(I) Filter tag
name	(O) Name of Filter
desc	(O) Description of the Filter
scope	(O) Scope
n_clauses	(O) Number of clauses

PIE_API int PIE_describe_filter2	(	tag_t	filter_tag,
		char **	name,
		char **	desc,
		PIE_scope_t *	scope,
		int *	n_clauses
	)

Parameters

filter_tag	(I) Filter tag
name	(OF) Name of Filter
desc	(OF) Description of the Filter
scope	(O) Scope
n_clauses	(O) Number of clauses

PIE_API int PIE_describe_option_set	(	tag_t	option_set_tag,
		char	option_set_name[WSO_name_size_c+1],
		char	option_set_description[WSO_desc_size_c+1],
		tag_t *	transfermode,
		char	transfermode_name[WSO_name_size_c+1],
		tag_t *	site,
		int *	n_options,
		char ***	option_names,
		char ***	option_display_names,
		char ***	option_values,
		char ***	option_descriptions,
		char ***	option_group_names,
		logical **	option_read_only_flags
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_describe_option_set2

Parameters

option_set_tag	(I) Option Set Tag
option_set_name	(O) Option Set Name
option_set_description	(O) Option Set Description
transfermode	(O) Transfermode Tag
transfermode_name	(O) Transfermode Name
site	(O) Site Tag
n_options	(O) Number of Options
option_names	(OF) n_options Option Names
option_display_names	(OF) n_options Option Display Names
option_values	(OF) n_options Option Initial Values
option_descriptions	(OF) n_options Option Descriptions
option_group_names	(OF) n_options Option Group Names
option_read_only_flags	(OF) n_options Option Read only flags

PIE_API int PIE_describe_option_set2	(	tag_t	option_set_tag,
		char **	option_set_name,
		char **	option_set_description,
		tag_t *	transfermode,
		char **	transfermode_name,
		tag_t *	site,
		int *	n_options,
		char ***	option_names,
		char ***	option_display_names,
		char ***	option_values,
		char ***	option_descriptions,
		char ***	option_group_names,
		logical **	option_read_only_flags
	)

Parameters

option_set_tag	(I) Option Set Tag
option_set_name	(OF) Option Set Name
option_set_description	(OF) Option Set Description
transfermode	(O) Transfermode Tag
transfermode_name	(OF) Transfermode Name
site	(O) Site Tag
n_options	(O) Number of Options
option_names	(OF) n_options Option Names
option_display_names	(OF) n_options Option Display Names
option_values	(OF) n_options Option Initial Values
option_descriptions	(OF) n_options Option Descriptions
option_group_names	(OF) n_options Option Group Names
option_read_only_flags	(OF) n_options Option Read only flags

PIE_API int PIE_describe_prop_set	(	tag_t	prop_set,
		char	name[PIE_name_size_c+1],
		char	desc[PIE_desc_size_c+1],
		PIE_scope_t *	scope,
		int *	n_clauses
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_describe_prop_set2

Parameters

prop_set	(I) Property set tag
name	(O) Name of Property Set
desc	(O) Description of the property set
scope	(O) Scope
n_clauses	(O) Number of clauses

PIE_API int PIE_describe_prop_set2	(	tag_t	prop_set,
		char **	name,
		char **	desc,
		PIE_scope_t *	scope,
		int *	n_clauses
	)

Parameters

prop_set	(I) Property set tag
name	(OF) Name of Property Set
desc	(OF) Description of the property set
scope	(O) Scope
n_clauses	(O) Number of clauses

PIE_API int PIE_extent_transfer_modes	(	int *	n_transfer_modes,
		tag_t **	transfer_modes
	)

Parameters

n_transfer_modes	(O) Number of transfer Modes
transfer_modes	(OF) n_transfer_modes Transfer Mode Tags

PIE_API int PIE_filter_add_clause	(	tag_t	filter,
		PIE_type_t	type_or_class,
		const char *	p_name,
		const char *	filter_name
	)

Parameters

filter	(I) Filter tag
type_or_class	(I) Whether Type or Class is used to specify the object
p_name	(I) Type or Class Name of the object
filter_name	(I) Name of filter to be applied

PIE_API int PIE_filter_get_clause	(	tag_t	filter,
		int	index,
		PIE_type_t *	type_or_class,
		char **	p_name,
		char **	filter_name
	)

Parameters

filter	(I) Filter tag
index	(I) Index of the clause
type_or_class	(O) Whether a Type or Class of the Object is specified
p_name	(OF) Type or Class Name of the Object
filter_name	(OF) Name of the filter

PIE_API int PIE_find_action	(	const char	name[PIE_name_size_c+1],
		PIE_scope_t	scope,
		int *	n_action_tags,
		tag_t **	action_tags
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_find_action2

Parameters

name	(I)
scope	(I)
n_action_tags	(O)
action_tags	(OF) n_action_tags

PIE_API int PIE_find_action2	(	const char *	name,
		PIE_scope_t	scope,
		int *	n_action_tags,
		tag_t **	action_tags
	)

Parameters

name	(I)
scope	(I)
n_action_tags	(O)
action_tags	(OF) n_action_tags

PIE_API int PIE_find_closure_rules	(	const char	name[PIE_name_size_c+1],
		PIE_scope_t	scope,
		int *	n_closure_tags,
		tag_t **	closure_tags
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_find_closure_rules2

Parameters

name	(I) Closure Rule name
scope	(I) Scope
n_closure_tags	(O) Number of tags
closure_tags	(OF) n_closure_tags Closure Rule tags

PIE_API int PIE_find_closure_rules2	(	const char *	name,
		PIE_scope_t	scope,
		int *	n_closure_tags,
		tag_t **	closure_tags
	)

Parameters

name	(I) Closure Rule name
scope	(I) Scope
n_closure_tags	(O) Number of tags
closure_tags	(OF) n_closure_tags Closure Rule tags

PIE_API int PIE_find_filter	(	const char	name[PIE_name_size_c+1],
		PIE_scope_t	scope,
		int *	n_filter_tags,
		tag_t **	filter_tags
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_find_filter2

Parameters

name	(I) Filter name
scope	(I) Scope
n_filter_tags	(O) Number of filter tags
filter_tags	(OF) n_filter_tags Filter tags

PIE_API int PIE_find_filter2	(	const char *	name,
		PIE_scope_t	scope,
		int *	n_filter_tags,
		tag_t **	filter_tags
	)

Parameters

name	(I) Filter name
scope	(I) Scope
n_filter_tags	(O) Number of filter tags
filter_tags	(OF) n_filter_tags Filter tags

PIE_API int PIE_find_object_by_appref	(	char *	appuid,
		char *	appl,
		char *	site,
		char *	ver,
		int *	count,
		tag_t **	found
	)

For AppUid

Parameters

appuid	(I)
appl	(I)
site	(I)
ver	(I)
count	(O)
found	(OF) n_objs

PIE_API int PIE_find_prop_set	(	const char	name[PIE_name_size_c+1],
		PIE_scope_t	scope,
		int *	n_propset_tags,
		tag_t **	propset_tags
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_find_prop_set2

Parameters

name	(I) Name of the property set
scope	(I) Scope
n_propset_tags	(O) Number of property sets
propset_tags	(OF) n_propset_tags Property Set tags

PIE_API int PIE_find_prop_set2	(	const char *	name,
		PIE_scope_t	scope,
		int *	n_propset_tags,
		tag_t **	propset_tags
	)

Parameters

name	(I) Name of the property set
scope	(I) Scope
n_propset_tags	(O) Number of property sets
propset_tags	(OF) n_propset_tags Property Set tags

PIE_API int PIE_find_transfer_mode	(	const char	transfer_mode_name[WSO_name_size_c+1],
		const char	context_string[PIE_context_size_c+1],
		int *	n_transfer_mode_tags,
		tag_t **	transfer_mode_tags
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_find_transfer_mode2

Parameters

transfer_mode_name	(I) Name of transfer mode
context_string	(I) Context string
n_transfer_mode_tags	(O) Number of Transfer Modes
transfer_mode_tags	(OF) n_transfer_mode_tags TransferMode tags

PIE_API int PIE_find_transfer_mode2	(	const char *	transfer_mode_name,
		const char *	context_string,
		int *	n_transfer_mode_tags,
		tag_t **	transfer_mode_tags
	)

Parameters

transfer_mode_name	(I) Name of transfer mode
context_string	(I) Context string
n_transfer_mode_tags	(O) Number of Transfer Modes
transfer_mode_tags	(OF) n_transfer_mode_tags TransferMode tags

PIE_API int PIE_find_transfer_option_set	(	const char *	transfer_option_set_name,
		int *	num_transfer_option_set_tags,
		tag_t **	transfer_option_set_tags
	)

Finds the TransferOptionSet based on the given name.

Returns

ITK_ok on success
Error code for any failure raised during data query from db

Parameters

transfer_option_set_name	(I) Name of transfer option set
num_transfer_option_set_tags	(O) Number of transfer option sets
transfer_option_set_tags	(OF) num_transfer_option_set_tags Array of transfer option sets

PIE_API int PIE_get_available_transfer_option_sets	(	tag_t	user,
		tag_t	group,
		tag_t	role,
		int	n_sites,
		tag_t *	sites,
		logical	is_push,
		logical	is_export,
		int *	n_optionsets,
		tag_t **	option_set_objs
	)

The following api is used by online and offline (briefcase) transfers and here is the usage of the parameters ispush and isexoport for various cases

case 1: remote export - on-line — ispush = true isexport = true exporting option set for local site case 2: remote import - on-line — ispush = false isexport = true exporting option set for remote site case 3: briefcase export - off-line — ispush = true isexport = true exporting option set for local site case 4: briefcase import - off-line — ispush = na isexport = false importing option set for briefcase import

Parameters

user	(I) User Tag
group	(I) Group Tag
role	(I) Role Tag
n_sites	(I) Number of Sites
sites	(I) Site Tags
is_push	(I) Is it a Push case or Pull
is_export	(I) Is it a Export Option Set
n_optionsets	(O) Number of Option Set Objects
option_set_objs	(OF) n_optionsets List of OptionSet objects

PIE_API int PIE_get_delta_adds	(	tag_t	delta_info,
		int *	n_objs,
		tag_t **	added_objs
	)

Parameters

delta_info	(I)
n_objs	(O)
added_objs	(OF) n_objs

PIE_API int PIE_get_delta_deletes	(	tag_t	delta_info,
		int *	n_objs,
		tag_t **	deleted_objs
	)

Parameters

delta_info	(I)
n_objs	(O)
deleted_objs	(OF) n_objs

PIE_API int PIE_get_delta_modifications	(	tag_t	delta_info,
		int *	n_objs,
		tag_t **	modified_objs
	)

Parameters

delta_info	(I)
n_objs	(O)
modified_objs	(OF) n_objs

PIE_API int PIE_merge_delta_to_base	(	tag_t	session,
		tag_t *	merged_xml_file
	)

Parameters

session	(I)
merged_xml_file	(O)

PIE_API int PIE_prop_add_clause	(	tag_t	prop_set,
		PIE_type_t	type_or_class,
		const char *	p_name,
		PIE_connection_type_t	prop_or_attr,
		const char *	a_name,
		PIE_prop_rule_type_t	rule_type
	)

Parameters

prop_set	(I) Property Set tag
type_or_class	(I) Whether Type or Class of Property set is specified
p_name	(I) Type or class name of the property set
prop_or_attr	(I) The connection type ?property or attribute
a_name	(I) Name of the property or attribute
rule_type	(I) The directive specification

PIE_API int PIE_prop_get_clause	(	tag_t	prop_set,
		int	index,
		PIE_type_t *	type_or_class,
		char **	p_name,
		PIE_connection_type_t *	prop_or_attr,
		char **	a_name,
		PIE_prop_rule_type_t *	rule_type
	)

Parameters

prop_set	(I) Property Set tag
index	(I) Index of the clause
type_or_class	(O) Whether Type or Class is used to specify the object
p_name	(OF) Type or Class name of the object
prop_or_attr	(O) The connectivity type - property or attribute
a_name	(OF) The property or attribute name
rule_type	(O) The directive specification

PIE_API int PIE_session_add_info	(	tag_t	session,
		int	n_strings,
		char **	titles,
		char **	values
	)

Parameters

session	(I) Session tag
n_strings	(I) Number of strings
titles	(I) n_strings List of titles
values	(I) n_values List of values

PIE_API int PIE_session_ask_file	(	tag_t	session,
		const char **	file_name
	)

Parameters

session	(I)
file_name	(O) File name in buffer that should be SM_free'd

PIE_API int PIE_session_ask_info	(	tag_t	session,
		int *	n_strings,
		char ***	titles,
		char ***	values
	)

Parameters

session	(I) Session tag
n_strings	(O) Number of strings
titles	(OF) n_strings List of titles
values	(OF) n_strings List of values

PIE_API int PIE_session_ask_transfer_mode	(	tag_t	session,
		tag_t *	transfer_mode
	)

Parameters

session	(I)
transfer_mode	(O)

PIE_API int PIE_session_export_objects	(	tag_t	session,
		int	n_objs,
		tag_t *	obj_list
	)

Parameters

session	(I) Session tag
n_objs	(I) Number of objects to be exported
obj_list	(I) n_objs List of objects to be exported

PIE_API int PIE_session_get_errors	(	tag_t	session,
		int *	n_errors,
		tag_t **	error_objs,
		int **	error_codes
	)

Get the errors occured during export of objects from session. This method gives you no. of objects failed to export, their tag and error code due to which failure happened.

Parameters

session	(I) Session tag
n_errors	(O) Number of errors
error_objs	(OF) n_errors List of error objects
error_codes	(OF) n_errors List of error codes

PIE_API int PIE_session_get_export_locales	(	tag_t	session,
		int *	exportlocaleCount,
		char ***	exportLocales
	)

Get the export locales from the session. The locales returned would follow the standard Java locale naming convention: 2letterlanguage_2LETTRAREA (eg: en_US).

Parameters

session	(I) Unique identifier(tag) of the export session.
exportlocaleCount	(O) Number of languages set in the export session.
exportLocales	(OF)List of languages to be exported with.

PIE_API int PIE_session_get_import_errors	(	tag_t	session,
		int *	n_errors,
		char ***	error_ids,
		int **	error_codes
	)

Get the errors occured during import of objects from session. This method gives you no. of PLMXML objects failed to import, their PLMXML ids and error code due to which failure happened.

Parameters

session	(I) Session tag
n_errors	(O) Number of errors
error_ids	(OF) n_errors List of error element ids in PLMXML file
error_codes	(OF) n_errors List of error codes

PIE_API int PIE_session_get_incremental_change	(	tag_t	session,
		tag_t *	incremental_change
	)

PIE_API int PIE_session_get_log_lines	(	tag_t	session,
		int *	n_lines,
		char ***	log_lines
	)

DEPRECATED FUNCTION This function is replaced by PIE_session_get_errors() or PIE_session_get_import_errors()

Deprecated:: This function is deprecated and will be removed from Teamcenter 11

Parameters

session	(I) Session tag
n_lines	(O) Number of lines
log_lines	(OF) n_lines Log lines

PIE_API int PIE_session_get_plmxml_document	(	tag_t	session,
		void **	plmxmlDoc
	)

Get the PLM XML document of the session.

Parameters

session	(I) Unique identifier(tag) of the session.
plmxmlDoc	(O) The PLM XML document in the current session.

PIE_API int PIE_session_get_processed_plmxml_object	(	tag_t	session,
		tag_t	obj,
		void **	plmxmlObj,
		int *	failCode
	)

Given a Teamcenter object, get the corresponding PLM XML object exported,and failure code during the processing of the object if any.

Parameters

session	(I) Unique identifier(tag) of the session.
obj	(I) Tag of Teamcenter object.
plmxmlObj	(O) PLM XML object.
failCode	(O) Any failure during the processing of the object.

PIE_API int PIE_session_get_processed_tc_object	(	tag_t	session,
		void *	plmxmlObj,
		tag_t *	obj,
		int *	failCode
	)

Given a PLM XML object, get the corresponding Teamcenter object imported,and failure code during the processing of the object if any.

Parameters

session	(I) Unique identifier(tag) of the session.
plmxmlObj	(I) PLM XML object.
obj	(O) Tag of Teamcenter object.
failCode	(O) Any failure during the processing of the object.

PIE_API int PIE_session_get_rule_types	(	tag_t	session,
		int *	n_types,
		char ***	typeNames
	)

Parameters

session	(I)
n_types	(O)
typeNames	(OF) n_types

PIE_API int PIE_session_get_target_pathname	(	tag_t	session,
		char **	pathname
	)

Parameters

session	(I)
pathname	(OF)

PIE_API int PIE_session_get_user_xslt_file	(	tag_t	session,
		char **	user_xslt_fname
	)

Parameters

session	(I) Session tag
user_xslt_fname	(OF) User XSLT file name

PIE_API int PIE_session_get_xslt	(	tag_t	session,
		logical *	override,
		int *	n_files,
		tag_t **	xslt_files
	)

DEPRECATED FUNCTION This function is replaced by PIE_session_get_user_xslt_file()

Deprecated:: This function is deprecated and will be removed from Teamcenter 11

Parameters

session	(I) Session tag
override	(O) Whether to override
n_files	(O) Number of files
xslt_files	(OF) n_files List of xslt files

PIE_API int PIE_session_import_objects	(	tag_t	session,
		logical	dry_run,
		int *	n_objs,
		tag_t **	obj_list
	)

Do not import the files during a dry_run

Parameters

session	(I) Session tag
dry_run	(I) Whether only a dry run should be carried out
n_objs	(O) Number of objects imported
obj_list	(OF) n_objs List of objects exported

PIE_API int PIE_session_set_edit_targets	(	tag_t	session,
		int	num_tags,
		tag_t *	tags_allowed_to_edit
	)

Parameters

session	(I) Session tag
num_tags	(I) Number of objects to be edited
tags_allowed_to_edit	(I) n_objs List of objects to be edited

PIE_API int PIE_session_set_export_locales	(	tag_t	session,
		const int	exportlocaleCount,
		char **	exportLocales
	)

Set the export locales to the session. The exported file contains the translations in the locales set to the session. The Site Master Language translation will always be included. The locales should follow the standard Java locale naming convention: 2letterlanguage_2LETTRAREA (eg: en_US).

Parameters

session	(I) Unique identifier(tag) of the export session.
exportlocaleCount	(I) Number of languages set in the export session.
exportLocales	(I) List of languages to be exported with.

PIE_API int PIE_session_set_file	(	tag_t	session,
		const char *	file_name
	)

Parameters

session	(I) Session tag
file_name	(I) File name

PIE_API int PIE_session_set_ic_exclusion_list	(	tag_t	session,
		int	num_tags,
		tag_t *	ic_tags_to_exclude
	)

Sets the Incremental Changes (IC) which are to be assumed as unmodified and hence explicitly excluded from the current IC based delta export. An error CXPOM_invalid_tag (7007) will be returned if the session tag is invalid. In all other cases, the function will return ITK_ok.

Parameters

session	(I) Session tag
num_tags	(I) Number of Incremental Changes to be excluded
ic_tags_to_exclude	(I) List of Incremental Changes to be excluded

PIE_API int PIE_session_set_incremental_change	(	tag_t	session,
		tag_t	incremental_change
	)

PIE_API int PIE_session_set_log_file	(	tag_t	session,
		const char *	file_name
	)

Parameters

session	(I) Session tag
file_name	(I) File name

PIE_API int PIE_session_set_revision_rule	(	tag_t	session,
		tag_t	revision_rule
	)

Parameters

session	(I)
revision_rule	(I)

PIE_API int PIE_session_set_target_pathname	(	tag_t	session,
		char *	pathname
	)

Parameters

session	(I)
pathname	(I)

PIE_API int PIE_session_set_transfer_mode	(	tag_t	session,
		tag_t	transfer_mode
	)

Parameters

session	(I) Session tag
transfer_mode	(I) Transfer mode associated with the session

PIE_API int PIE_session_set_user_xslt_file	(	tag_t	session,
		const char *	user_xslt_fname
	)

Parameters

session	(I) Session tag
user_xslt_fname	(I) The User XSLT file name

PIE_API int PIE_session_set_xslt	(	tag_t	session,
		logical	override,
		int	n_files,
		tag_t *	xslt_files
	)

DEPRECATED FUNCTION This function is replaced by PIE_session_set_user_xslt_file()

Deprecated:: This function is deprecated and will be removed from Teamcenter 11

Parameters

session	(I) Session tag
override	(I) Whether to override
n_files	(I) Number of files
xslt_files	(I) n_files Number of xslt files

PIE_API int PIE_session_update_processed_object	(	tag_t	session,
		tag_t	obj,
		void *	plmxmlObj,
		int	failCode
	)

Update the processed object in ObjectMap. This can be used for both export and import To add the Teamcenter object and the corresponding PLM XML object in the processed object list

Parameters

session	(I) Unique identifier(tag) of the session.
obj	(I) Tag of Teamcenter object.
plmxmlObj	(I) PLM XML object.
failCode	(I) Any failure during the processing of the object.

PIE_API int PIE_transfer_mode_get_action_list	(	tag_t	transfer_mode,
		int *	n_action_list_objs,
		tag_t **	action_list_objs
	)

Parameters

transfer_mode	(I) Input Transfer Mode tag
n_action_list_objs	(O) Number of Action Lists
action_list_objs	(OF) n_action_list_objs Action List Objects

PIE_API int PIE_transfer_mode_get_closures	(	tag_t	transfer_mode,
		tag_t *	closure
	)

Parameters

transfer_mode	(I) Transfer Mode
closure	(O) The Closure Rule associated with the transfer mode

PIE_API int PIE_transfer_mode_get_config_objs	(	tag_t	transfer_mode,
		int *	n_config_objs,
		tag_t **	config_objs
	)

Parameters

transfer_mode	(I) Transfer Mode
n_config_objs	(O) Number of config objects
config_objs	(OF) n_config_objs Config Objects

PIE_API int PIE_transfer_mode_get_context_string	(	tag_t	transfer_mode,
		char	context_string[PIE_context_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_transfer_mode_get_context_string2

Parameters

transfer_mode	(I) Input Transfer Mode tag
context_string	(O) Output variable specifying the context string

PIE_API int PIE_transfer_mode_get_context_string2	(	tag_t	transfer_mode,
		char **	context_string
	)

Parameters

transfer_mode	(I) Input Transfer Mode tag
context_string	(OF) Output variable specifying the context string

PIE_API int PIE_transfer_mode_get_direction	(	tag_t	transfer_mode,
		PIE_direction_t *	direction
	)

Parameters

transfer_mode	(I) Input Transfer Mode Tag
direction	(O) Output variable indicating the Direction of transfer (export or import)

PIE_API int PIE_transfer_mode_get_filters	(	tag_t	transfer_mode,
		tag_t *	filter
	)

Parameters

transfer_mode	(I) Transfer Mode
filter	(O) The Filter to be associated with the transfer mode

PIE_API int PIE_transfer_mode_get_incremental	(	tag_t	transfer_mode,
		logical *	incremental
	)

Parameters

transfer_mode	(I) Input Transfer Mode Tag
incremental	(O) Output variable indicating whether the transfer is incremental

PIE_API int PIE_transfer_mode_get_multisite	(	tag_t	transfer_mode,
		logical *	multisite
	)

PIE_API int PIE_transfer_mode_get_prop_set	(	tag_t	transfer_mode,
		tag_t *	prop_set
	)

Parameters

transfer_mode	(I) Transfer Mode
prop_set	(O) The PropertySet associated with the transfer mode

PIE_API int PIE_transfer_mode_get_schema_format	(	tag_t	transfer_mode,
		PIE_schema_t *	schema_format
	)

Parameters

transfer_mode	(I) Input Transfer Mode Tag
schema_format	(O) Output variable indicating the Schema format of transfer (PLMXML or TCXML)

PIE_API int PIE_transfer_mode_get_xslt	(	tag_t	transfer_mode,
		int *	n_files,
		tag_t **	xslt_files
	)

Parameters

transfer_mode	(I) Input Transfer Mode Tag
n_files	(O) Number of xslt files
xslt_files	(OF) n_files Array of xslt files

PIE_API int PIE_transfer_mode_load_defaults ( tag_t transfer_mode )

Parameters

transfer_mode (I)

PIE_API int PIE_transfer_mode_remove_xslt	(	tag_t	transfer_mode,
		tag_t	xslt_file
	)

Parameters

transfer_mode	(I)
xslt_file	(I)

PIE_API int PIE_transfer_mode_set_action_list	(	tag_t	transfer_mode,
		int	n_action_list_objs,
		tag_t *	action_list_objs
	)

Parameters

transfer_mode	(I) Input Transfer Mode tag
n_action_list_objs	(I) Number of Action Lists
action_list_objs	(I) n_action_list_objs Action List Objects

PIE_API int PIE_transfer_mode_set_closures	(	tag_t	transfer_mode,
		tag_t	closure
	)

Parameters

transfer_mode	(I) Transfer Mode
closure	(I) The Closure Rule to be associated with the transfer mode

PIE_API int PIE_transfer_mode_set_config_objs	(	tag_t	transfer_mode,
		int	n_config_objs,
		tag_t *	config_objs
	)

Parameters

transfer_mode	(I) Input Transfer Mode tag
n_config_objs	(I) Number of Config Objects
config_objs	(I) Config Objects

PIE_API int PIE_transfer_mode_set_context_string	(	tag_t	transfer_mode,
		const char	context_string[PIE_context_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PIE_transfer_mode_set_context_string2

Parameters

transfer_mode	(I) Input Transfer Mode tag
context_string	(I) Input variable specifying the context string

PIE_API int PIE_transfer_mode_set_context_string2	(	tag_t	transfer_mode,
		const char *	context_string
	)

Parameters

transfer_mode	(I) Input Transfer Mode tag
context_string	(I) Input variable specifying the context string

PIE_API int PIE_transfer_mode_set_direction	(	tag_t	transfer_mode,
		PIE_direction_t	direction
	)

Parameters

transfer_mode	(I) Input Transfer Mode Tag
direction	(I) Input variable indicating the Direction of Transfer (import or export)

PIE_API int PIE_transfer_mode_set_filters	(	tag_t	transfer_mode,
		tag_t	filter
	)

Parameters

transfer_mode	(I) Transfer Mode
filter	(I) The Filter to be associated with the transfer mode

PIE_API int PIE_transfer_mode_set_incremental	(	tag_t	transfer_mode,
		logical	incremental
	)

Parameters

transfer_mode	(I) Input Transfer Mode Tag
incremental	(I) Output variable indicating whether the transfer is incremental

PIE_API int PIE_transfer_mode_set_multisite	(	tag_t	transfer_mode,
		logical	multisite
	)

PIE_API int PIE_transfer_mode_set_prop_set	(	tag_t	transfer_mode,
		tag_t	prop_set
	)

Parameters

transfer_mode	(I) Input Transfer Mode tag
prop_set	(I) The PropertySet to be associated with the transfer mode

PIE_API int PIE_transfer_mode_set_schema_format	(	tag_t	transfer_mode,
		PIE_schema_t	schema_format
	)

Parameters

transfer_mode	(I) Input Transfer Mode Tag
schema_format	(I) Input variable indicating the Schema format of Transfer (PLMXML or TCXML)

PIE_API int PIE_transfer_mode_set_xslt	(	tag_t	transfer_mode,
		int	n_files,
		tag_t *	xslt_files
	)

Parameters

transfer_mode	(I) Transfer Mode
n_files	(I) Number of XSLT Files
xslt_files	(I) n_files XSLT File Tags

Modules

Macros

Typedefs

Enumerations

Functions

Action Rule Calls

Property Set Calls

Option Set Related APIs

PIE Session calls

PIE Delta Calls

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation