user_exits.h File Reference

#include <tc/tc_startup.h>
#include <common/emh_const.h>
#include <unidefs.h>
#include <tccore/method.h>
#include <qry/qry.h>
#include <sub_mgr/tcactionhandler.h>
#include <sub_mgr/subscription.h>
#include <tccore/workspaceobject.h>
#include <sa/tcfile.h>
#include <ai/aiws_extensions.h>
#include <user_exits/libuser_exits_exports.h>
#include <user_exits/libuser_exits_undef.h>

Go to the source code of this file.

Data Structures
struct	USER_DATASET_details_s
struct	USER_prop_init_entry_s

Macros
#define	USER_DATASET_always_copy   0
#define	USER_DATASET_never_copy   1
#define	USER_DATASET_user_chooses   2
#define	USER_EXIT   (EMH_UE_error_base + 1)

Typedefs
typedef enum IDClass_e_obsolete	IDClass_e
typedef enum IDFunc_e_obsolete	IDFunc_e
typedef enum IDValid_t	IDValid_e
typedef enum IVFType	IVFType_e
typedef enum IVFType *	IVFType_ep
typedef struct USER_DATASET_details_s *	USER_DATASET_details_p_t
typedef struct USER_DATASET_details_s	USER_DATASET_details_t
typedef struct USER_prop_init_entry_s	USER_prop_init_entry_t

Enumerations
enum	IDClass_e_obsolete { ID_BAD_CLASS, ID_WORKING, ID_OFFICIAL }
enum	IDFunc_e_obsolete { ID_BAD_FUNC, ID_SAVEAS, ID_CREATE, ID_FREEZE }
enum	IDValid_t {   USER_valid_id, USER_invalid_id, USER_modified_id, USER_override_id,   USER_duplicate_id }
enum	IVFType { IVF_BAD_TYPE, IVF_PRODUCT, IVF_STRUCTURE_GROUP, IVF_COMPONENT }

Functions
USER_EXITS_API int	USER_add_canned_methods (void)
USER_EXITS_API int	USER_appr_item_is_above_ERCT (tag_t appr_context, tag_t item_tag, logical *is_above_erct)
USER_EXITS_API int	USER_ask_display_revisions (tag_t item_tag, int *count, tag_t **revisions)
USER_EXITS_API int	USER_baseline_dryrun_validator (const char *baseRevListFullFileName)
USER_EXITS_API int	USER_bomline_is_preferred_ancestor (tag_t bomline_or_appearance, logical is_bomline, logical *is_preferred_ancestor)
USER_EXITS_API int	USER_build_notify_message (const TcSubscriptionActionMsg_t *theSubscriptionMsg, char **messageSubject, int *nMessageLines, char ***messageLines)
USER_EXITS_API int	USER_build_notify_message_with_locale (const TcSubscriptionActionMsg_t *theSubscriptionMsg, const char *localeStr, char **messageSubject, int *nMessageLines, char ***messageLines)
USER_EXITS_API int	USER_copied_datasets_details (tag_t old_revision, const char *new_item_id, const char *new_revision_id, const char *new_item_type, int dataset_count, tag_t dataset_list[], USER_DATASET_details_t **details, logical *allow_duplicates)
USER_EXITS_API int	USER_exit_module (void)
USER_EXITS_API int	USER_gs_shell_init_module (void)
USER_EXITS_API int	USER_init_module (void)
USER_EXITS_API int	USER_is_dataset_exportable (tag_t dataset_tag, int n_target_sites, tag_t *target_sites, logical is_transferring_ownership, logical modified_objects_only, logical *isExportable)
USER_EXITS_API int	USER_is_item_rev_mature (tag_t item_rev_tag, logical *mature)
USER_EXITS_API int	USER_make_design_rev_primary_precond (tag_t part_rev, tag_t design_rev, logical *isDesignRevEligible)
USER_EXITS_API int	USER_markup_pre_action_handler (METHOD_message_t *msg, va_list args)
USER_EXITS_API int	USER_new_alt_id (tag_t idcontext_tag, const char *preferred_pattern, tag_t altid_type_tag, tag_t parent_altid_tag, char **new_id)
USER_EXITS_API int	USER_new_dataset_id (const tag_t relatedTag, const char *ds_type, logical *mod, char **id)
USER_EXITS_API int	USER_new_dataset_rev (const char *ds_id, const char *ds_type, logical *mod, char **id)
USER_EXITS_API void	USER_nx_shell_init_module (void)
USER_EXITS_API int	USER_preinit_module (void)
USER_EXITS_API int	USER_register_aiws_extensions ()
USER_EXITS_API void	USER_register_bomline_attrs (char *attr_class)
USER_EXITS_API int	USER_register_plmxml_actions ()
USER_EXITS_API int	USER_register_plmxml_export_methods ()
USER_EXITS_API int	USER_register_plmxml_filters ()
USER_EXITS_API int	USER_register_plmxml_import_methods ()
USER_EXITS_API int	USER_register_plmxml_schema_mappings ()
USER_EXITS_API int	USER_register_properties (void)
USER_EXITS_API int	USER_register_tcplmxml_actions ()
USER_EXITS_API int	USER_register_tcplmxml_filters ()
USER_EXITS_API int	USER_synchronize_baseline (const char *fullFilePathName)
USER_EXITS_API int	USER_validate_alt_id (tag_t idcontext_tag, const char *idfr_type, const char *new_id, const char *pattern_name, char **modified_id, IDValid_e *status)
USER_EXITS_API int	USER_validate_alternate (tag_t idcontext_tag, tag_t identifiable_tag, tag_t altid_type, tag_t altid_tag, logical *is_valid)
USER_EXITS_API int	USER_validate_dataset_name (tag_t old_owner, tag_t old_dataset, const char *new_item_id, const char *new_revision_id, const char *item_type, const char *dataset_name, logical *valid)
User Exits for File Names
USER_EXITS_API char *	USER_new_file_name (const char *dataset, const char *ref, const char *ext, const int rev)
USER_EXITS_API int	PEC_Log_Handler (const TcSubscriptionActionMsg_t *subscriptionActionMsg, int nHandlerArgs, char **handlerArgs, va_list otherArgs)
USER_EXITS_API char *	USER_rev_file_name (const char *old_file_name)
User Exits for Archive and Restore
USER_EXITS_API char *	USER_default_archive_filename (void)
USER_EXITS_API char *	USER_default_archive_tape_label (void)
Part number generation routines
USER_EXITS_API int	USER_create_id_counter (char *counter)
USER_EXITS_API void	USER_define_tc_next_id (void)
USER_EXITS_API void	USER_create_instance_item_next_id (void)
User Exits for Items and Item Revisions
USER_EXITS_API int	USER_new_item_id (tag_t old_item, tag_t item_type, logical *mod, char **id)
USER_EXITS_API int	USER_new_item_ids (tag_t item_type, int quantity, logical *mod, char ***ids)
USER_EXITS_API int	USER_new_revision_id (tag_t item_tag, tag_t item_type, logical *mod, char **id)
USER_EXITS_API int	USER_new_revision_id_from_alt_rule (char *rule_suffix, tag_t item_tag, tag_t item_type, logical *mod, char **id)
USER_EXITS_API int	USER_validate_item_rev_id (const char *item_id, const char *rev_id, const char *item_type, char **modified_item_id, char **modified_rev_id, IDValid_e *status)
USER_EXITS_API int	USER_validate_item_rev_id_2 (const char *item_id, const char *rev_id, const char *item_type, char **modified_item_id, char **modified_rev_id, IDValid_e *status_item_id, IDValid_e *status_rev_id)
USER_EXITS_API int	USER_validate_item_rev_id_3 (const char *item_id, const char *rev_id, const tag_t item_tag, const char *item_type, char **modified_item_id, char **modified_rev_id, IDValid_e *status_item_id, IDValid_e *status_rev_id)
User Exits for Non Master Handling During Save As
Teamcenter User Exits (default implementations).
USER_EXITS_API int	USER_new_dataset_name (tag_t owner, tag_t dataset_type, tag_t relation_type, const char *basis_name, char **dataset_name, logical *modifiable)
USER_EXITS_API int	USER_new_allocation_name (tag_t allocation_map_rev, tag_t alloc_type, char **new_allocation_name)
USER_EXITS_API int	USER_is_allocation_correct (tag_t allocation_tag, tag_t allocation_window_tag, logical *is_correct)
USER_EXITS_API int	USER_is_allocation_complete (tag_t allocation_tag, tag_t allocation_window_tag, logical *is_complete)
USER_EXITS_API int	USER_is_allocation_configured (tag_t rev_rule, logical *is_configured)
USER_EXITS_API int	USER_copied_dataset_name (tag_t old_owner, tag_t old_dataset, tag_t relation_type, tag_t new_owner, char **dataset_name, logical *modifiable)
USER_EXITS_API int	USER_item_created (const char *item_id, const char *revision_id)
USER_EXITS_API int	USER_item_create_cancelled (const char *item_id, const char *revision_id)
USER_EXITS_API char *	USER_ask_for_new_sequence_no (tag_t parent_bom_revision)
USER_EXITS_API int	USER_ask_new_seqno (tag_t parent_bom_rev, tag_t item, char **seqno)
USER_EXITS_API int	USER_ask_seq_numbers (tag_t parent_bvr, int count, tag_t *child, char ***seqnos)
USER_EXITS_API int	USER_query_execute (const char *name, int num_args, char **keys, char **values, int *n_columns, char ***col_names, QRY_user_query_row_t **rows)
USER_EXITS_API int	USER_query_map_row (const char *query_name, const QRY_user_query_row_t *row, tag_t *tag)
USER_EXITS_API int	USER_query_free_rows (QRY_user_query_row_t *rows, int n_columns)
USER_EXITS_API int	USER_execute_saved_query (const char *name, int num_args, char **keys, char **values, int *num_found, tag_t **found)
USER_EXITS_API int	USER_get_keyword_search_client (const char *name, int num_args, char **names, char **values, char **search_client)
USER_EXITS_API int	USER_process_keyword_search_results (const char *name, FILE *f_ptr, int *num_found, tag_t **results)
USER_EXITS_API void	NOTE_ask_extension (char *file_name, char *extension)
USER_EXITS_API void	USER_invoke_pdm_server (int input_code, char *input_string, int *output_code, char **output_string)
USER_EXITS_API int	USER_invoke_user_code_string (int input_code, const char *input_string, int *output_code, char **output_string)
USER_EXITS_API int	USER_invoke_user_code_taglist (int input_code, const char *input_string, tag_t input_tag, tag_t *output_tag, char **output_string, int *output_count, tag_t **output_taglist)
USER_EXITS_API int	USER_invoke_user_create_objs (tag_t tag, char *form_name, char *num_of_cost_elem, const char *plant, char *currency, char *lead_time, char *supplier, char *percentage, char *titles, char *element_vals, char *ar_number, char *sender_psp, char *receiver_psp, char *sap_index, char *sap_date, char *sap_amount, char *purchase_req, char *comments, char *deleted_index, char *ignored_index, char *modified_index, char *added_index)
USER_EXITS_API void *	user_StringLtoRCreate (char *text)
USER_EXITS_API int	USER_string_compare (const char *s1, const char *s2)
User Exits for UIF
USER_EXITS_API int	USER_new_current_group (tag_t group_tag, tag_t role_tag)
Item creation & copy
USER_EXITS_API int	USER_copy_revision (const char *rev_id, tag_t source_rev)
USER_EXITS_API int	USER_create_revision (tag_t item_tag, const char *rev_id)
USER_EXITS_API int	USER_create_item (const char *item_id, const char *name, const char *type, const char *rev_id)
User Exits for BOM Compare
USER_EXITS_API int	USER_bom_cmp_start_report (tag_t line1, tag_t line2, int mode, int output)
USER_EXITS_API int	USER_bom_cmp_enter_report (tag_t line1, tag_t line2, int mode, int output)
USER_EXITS_API int	USER_bom_cmp_item_report (tag_t cmp_item, int depth)
USER_EXITS_API int	USER_bom_cmp_parent_report (tag_t bom_line, int depth)
USER_EXITS_API int	USER_bom_cmp_exit_report ()
USER_EXITS_API int	USER_bom_cmp_end_report (logical changes)
USER_EXITS_API int	USER_define_compare_descs ()
USER_EXITS_API int	USER_define_bom_compare_modes ()
User Exits for BOMViews and BOMView Revisions
USER_EXITS_API int	USER_ps_default_bom_view_name (tag_t item, tag_t view_type, char **name)
USER_EXITS_API int	USER_ps_default_bvr_name (tag_t item_rev, tag_t view_type, char **name)
User Exits for Appearances
USER_EXITS_API int	USER_ps_update_appr_attr (tag_t appr, tag_t parent, tag_t occ, tag_t mapping)
USER_EXITS_API int	USER_appr_update_end_item_search_results (tag_t configuration_rule, int num_input_search_results, tag_t *input_search_results, int *num_output_search_results, tag_t **output_search_results)
User Exits for Folders and Forms
The User Exits feature controls the names of folders and forms during a Revise operation.
USER_EXITS_API int	USER_new_folder_name (tag_t parent_tag, char *parent_type, char *parent_name, char *basis_name, char *folder_type, logical *mod, char **new_name)
USER_EXITS_API int	USER_new_form_name (tag_t parent_tag, char *parent_type, char *parent_name, char *basis_name, char *form_type, logical *mod, char **new_name)
User exits for Global Teamcenter
USER_EXITS_API int	USER_ods_check_pubrec_access (tag_t pubrec_tag, const char *user_id, const char *group_name, const char *role_name, int client_site_id, logical *has_read_access)
USER_EXITS_API int	USER_ods_publish_object (int ods_site_id, tag_t object_tag)
USER_EXITS_API int	USER_idsm_start_remote_export (tag_t main_object_tag, int is_transferring_ownership, int ie_options, int remote_site_id, const char *remote_user_id, const char *remote_group_name, const char *remote_role_name)
USER_EXITS_API int	USER_idsm_end_remote_import (tag_t main_object_tag, int is_transferring_ownership, const char *export_directory)
USER_EXITS_API int	USER_end_local_import (tag_t main_object_tag, logical is_transferring_ownership, const char *export_directory)
USER_EXITS_API int	USER_end_import_of_item (tag_t item_tag)
User Exits for CM
USER_EXITS_API int	USER_ecm_get_prev_bvr (tag_t ec_rev_tag, tag_t bvr_tag, tag_t *prev_bvr_tag)
USER_EXITS_API int	USER_ecm_define_never_used_relations (tag_t ec_rev_tag, tag_t parent_ir_tag, tag_t aff_bvr_tag, tag_t pro_bvr_tag)
USER_EXITS_API int	USER_ecm_get_base_revision_rules (tag_t ec_rev_tag, tag_t affected_bvr_tag, tag_t problem_bvr_tag, logical *is_set, tag_t *affected_rule_tag, tag_t *problem_rule_tag)
USER_EXITS_API int	USER_ecm_get_process_name (tag_t change_rev_tag, int n_targets, tag_t *targets, char **process_name)
Report Writer user_exits
USER_EXITS_API int	USER_register_report_columns (void)
USER_EXITS_API logical	USER_report_include_row (tag_t pff_tag, int n_tags, tag_t *obj_tags)
Validation object user_exits
USER_EXITS_API int	USER_evaluate_compound_result (char *validation_name, int validation_status, logical *validation_result)
USER_EXITS_API int	USER_validation_post_action (tag_t target, logical validation_result, int validation_status)
USER_EXITS_API int	TCHANDLER_proxy_link (void *subMsg, int nRecipients, char **recipientList)
CAE Batch Meshing user_exits
USER_EXITS_API int	USER_get_batch_meshing_nr_name (const char *meshFileName, const char *meshSize, const char *meshFileExt, char namedRefName[IMF_filename_size_c+1])
USER_EXITS_API int	USER_get_batch_meshing_nr_name2 (const char *meshFileName, const char *meshSize, const char *meshFileExt, char **namedRefName)
USER_EXITS_API int	USER_ods_client_publish_extra_attributes (tag_t object_to_publish, int n_attrs, char **pr_pom_attr_names, char *attr_values[])
USER_EXITS_API int	USER_ods_client_ask_extra_attributes (int *n_attrs, char ***pr_pom_attr_names, char ***attr_options)
USER_EXITS_API int	USER_classification_autocompute_attr ()
USER_EXITS_API int	USER_compute_effectivity (tag_t blTag, logical intersectConfigEff, logical *occEffExists, logical *isConfigured, int *effyCount, WSOM_effectivity_info_t ***effectivityInfo)
USER_EXITS_API int	USER_validate_id (char *boType, int nKey, char **keys, char **values, logical *isValid)
USER_EXITS_API int	USER_where_used (char *bo_type, tag_t bo_tag, tag_t revision_rule, int *num_parents, tag_t **parents, int **levels)

Detailed Description

Include file to define entry points for user defined entry points.

Definition in file user_exits.h.