user_exits.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef USER_EXITS_H
#define USER_EXITS_H

#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>

#define USER_EXIT                 (EMH_UE_error_base + 1)

enum IVFType {
    IVF_BAD_TYPE,
    IVF_PRODUCT,
    IVF_STRUCTURE_GROUP,
    IVF_COMPONENT
};

typedef enum IVFType IVFType_e, *IVFType_ep;

typedef enum IDClass_e_obsolete {
    ID_BAD_CLASS,
    ID_WORKING,
    ID_OFFICIAL
} IDClass_e;

typedef enum IDFunc_e_obsolete {
    ID_BAD_FUNC,
    ID_SAVEAS,
    ID_CREATE,
    ID_FREEZE
} IDFunc_e;

typedef enum IDValid_t {
    USER_valid_id,
    USER_invalid_id,
    USER_modified_id,
    USER_override_id,
    USER_duplicate_id
} IDValid_e;

#define USER_DATASET_always_copy    0
#define USER_DATASET_never_copy     1
#define USER_DATASET_user_chooses   2

typedef struct USER_DATASET_details_s
{
    char    new_name[WSO_name_size_c+1];  
    int     copy_state;                   
    logical modifiable;                   
    logical validation_required;          
    logical original_owner;               
} USER_DATASET_details_t;

typedef struct USER_DATASET_details_s *USER_DATASET_details_p_t;

#include <user_exits/libuser_exits_exports.h>

#ifdef __cplusplus
    extern "C"{
#endif


extern USER_EXITS_API char* USER_new_file_name(
    const char*             dataset,    
    const char*             ref,        
    const char*             ext,        
    const int               rev         
    );


extern USER_EXITS_API int PEC_Log_Handler (
     const TcSubscriptionActionMsg_t* subscriptionActionMsg,
     int                                nHandlerArgs,
     char**                             handlerArgs,
     va_list                            otherArgs
     );


extern USER_EXITS_API char* USER_rev_file_name(
    const char*             old_file_name   
    );

extern USER_EXITS_API char* USER_default_archive_filename(void);

extern USER_EXITS_API char* USER_default_archive_tape_label(void);

extern USER_EXITS_API int USER_create_id_counter(
    char*                 counter   
    );

extern USER_EXITS_API void  USER_define_tc_next_id (void);

extern USER_EXITS_API void USER_create_instance_item_next_id (void);

extern USER_EXITS_API int USER_new_item_id (
    tag_t                 old_item,     
    tag_t                 item_type,    
    logical*              mod,          
    char**                id            
    );

extern USER_EXITS_API int USER_new_item_ids (
    tag_t                 item_type,    
    int                   quantity,     
    logical*              mod,          
    char***               ids           
    );

extern USER_EXITS_API int USER_new_revision_id(
    tag_t                 item_tag,     
    tag_t                 item_type,    
    logical*              mod,          
    char**                id            
    );

extern 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            
    );

extern 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                
    );
extern 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         
    );

/*
*
*   Validates the item and item revision identifiers selected for a new item
*   revision. This function may reject the supplied IDs, accept them or modify
*   them. This action is reflected in the value of status.
*
*   This function uses NR_validate_rev_id_field2 ITK function.
*   This function takes additional item_tag input for validating Rev ID.
*   Compared to the USER_validate_item_rev_id function, this returns a more
*   granular valid status - separate status for Item id and Revision Id.
*   This function will validate Item ID and Rev ID against Naming Rules only.
*   It will not perform validation for duplicate ID since with MFK enabled it
*   might be possible to have multiple Items with same ID.
*
*/
extern 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         
    );

extern 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        
    );

extern USER_EXITS_API int USER_new_allocation_name (
    tag_t               allocation_map_rev, 
    tag_t               alloc_type,         
    char **             new_allocation_name 
    );

extern USER_EXITS_API int USER_is_allocation_correct (
    tag_t               allocation_tag,        
    tag_t               allocation_window_tag, 
    logical*            is_correct             
    );

extern USER_EXITS_API int USER_is_allocation_complete (
    tag_t               allocation_tag,        
    tag_t               allocation_window_tag, 
    logical*            is_complete            
    );

extern USER_EXITS_API int USER_is_allocation_configured (
    tag_t               rev_rule,               
    logical*            is_configured           
    );

extern 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        
    );

extern USER_EXITS_API int USER_item_created(
    const char*           item_id,      
    const char*           revision_id   
    );

extern USER_EXITS_API int USER_item_create_cancelled(
    const char*           item_id,      
    const char*           revision_id   
    );

extern USER_EXITS_API char* USER_ask_for_new_sequence_no(
    tag_t                   parent_bom_revision 
    );

extern USER_EXITS_API int USER_ask_new_seqno (
    tag_t                 parent_bom_rev,   
    tag_t                 item,             
    char**                seqno             
    );

extern USER_EXITS_API int USER_ask_seq_numbers(
    tag_t                 parent_bvr, 
    int                   count,      
    tag_t*                child,      
    char***               seqnos      
    );

extern 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       
    );

extern USER_EXITS_API int USER_query_map_row(
    const char*                 query_name, 
    const QRY_user_query_row_t* row,        
    tag_t*                      tag         
    );

extern USER_EXITS_API int USER_query_free_rows(
    QRY_user_query_row_t*  rows,           
    int                    n_columns       
    );

extern USER_EXITS_API int USER_execute_saved_query(
    const char*           name,        
    int                   num_args,    
    char**                keys,        
    char**                values,      
    int*                  num_found,   
    tag_t**               found         
    );

extern USER_EXITS_API int USER_get_keyword_search_client(
    const char*           name,          
    int                   num_args,      
    char**                names,         
    char**                values,        
    char**                search_client     
    );

extern USER_EXITS_API int USER_process_keyword_search_results(
    const char*           name,         
    FILE*                 f_ptr,        
    int*                  num_found,    
    tag_t**               results       
    );

extern USER_EXITS_API void NOTE_ask_extension(
    char*                  file_name,
    char*                  extension
    );

extern USER_EXITS_API void USER_invoke_pdm_server(
    int                    input_code,
    char*                  input_string,
    int*                   output_code,
    char**                 output_string
    );

extern USER_EXITS_API int USER_invoke_user_code_string(
    int                   input_code,       
    const char*           input_string,     
    int*                  output_code,      
    char**                output_string     
    );

extern 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    
    );

extern 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       
    );


extern USER_EXITS_API void* user_StringLtoRCreate(
    char*                   text
    );

extern USER_EXITS_API int USER_string_compare (
    const char*           s1, 
    const char*           s2  
    );

extern USER_EXITS_API int USER_new_current_group(
    tag_t                 group_tag,    
    tag_t                 role_tag      
    );

extern USER_EXITS_API void USER_register_bomline_attrs(
    char*                  attr_class 
    );

extern USER_EXITS_API int USER_gs_shell_init_module(void);

extern USER_EXITS_API void USER_nx_shell_init_module(void);

extern USER_EXITS_API int USER_preinit_module ( void );

extern USER_EXITS_API int USER_init_module ( void );

extern USER_EXITS_API int USER_exit_module ( void );

extern USER_EXITS_API int USER_copy_revision(
    const char*           rev_id,       
    tag_t                 source_rev    
    );

extern USER_EXITS_API int USER_create_revision(
    tag_t                 item_tag,     
    const char*           rev_id        
    );

extern USER_EXITS_API int USER_create_item(
    const char*           item_id,  
    const char*           name,     
    const char*           type,     
    const char*           rev_id    
    );

extern USER_EXITS_API int USER_register_properties(void);

extern USER_EXITS_API int USER_bom_cmp_start_report(
    tag_t                 line1,    
    tag_t                 line2,    
    int                   mode,     
    int                   output    
    );

extern USER_EXITS_API int USER_bom_cmp_enter_report(
    tag_t                 line1,    
    tag_t                 line2,    
    int                   mode,     
    int                   output    
    );

extern USER_EXITS_API int USER_bom_cmp_item_report(
    tag_t                 cmp_item,     
    int                   depth         
    );

extern USER_EXITS_API int USER_bom_cmp_parent_report(
    tag_t                 bom_line,     
    int                   depth         
    );

extern USER_EXITS_API int USER_bom_cmp_exit_report( );

extern USER_EXITS_API int USER_bom_cmp_end_report(
    logical               changes   
    );

extern USER_EXITS_API int USER_define_compare_descs();

extern USER_EXITS_API int USER_define_bom_compare_modes();

extern USER_EXITS_API int USER_ps_default_bom_view_name(
    tag_t                 item,         
    tag_t                 view_type,    
    char**                name          
    );

extern USER_EXITS_API int USER_ps_default_bvr_name(
    tag_t                 item_rev,     
    tag_t                 view_type,    
    char**                name          
    );

extern USER_EXITS_API int USER_bomline_is_preferred_ancestor(
    tag_t                 bomline_or_appearance,    
    logical               is_bomline,               
    logical*              is_preferred_ancestor     
    );

extern USER_EXITS_API int USER_ps_update_appr_attr(
    tag_t                 appr,     
    tag_t                 parent,   
    tag_t                 occ,      
    tag_t                 mapping   
    );

extern 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         
    );

typedef struct USER_prop_init_entry_s
{
    char*                   type_name;
    METHOD_function_t       user_method;
    TC_argument_list_t*   user_args;
} USER_prop_init_entry_t;

extern USER_EXITS_API int USER_markup_pre_action_handler(
    METHOD_message_t*     msg,
    va_list               args
    );

extern USER_EXITS_API int USER_new_dataset_id(
    const tag_t           relatedTag,   
    const char*           ds_type,      
    logical*              mod,          
    char**                id            
    );

extern USER_EXITS_API int USER_new_dataset_rev(
    const char*           ds_id,    
    const char*           ds_type,  
    logical*              mod,      
    char**                id        
    );

extern 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      
    );

extern 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      
    );

extern 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   
    );

extern USER_EXITS_API int USER_ods_publish_object(
    int                   ods_site_id,  
    tag_t                 object_tag    
    );

extern 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              
    );

extern USER_EXITS_API int USER_idsm_end_remote_import(
    tag_t                 main_object_tag,              
    int                   is_transferring_ownership,    
    const char*           export_directory              
    );

extern USER_EXITS_API int USER_end_local_import(
    tag_t                 main_object_tag,              
    logical               is_transferring_ownership,    
    const char*           export_directory              
    );

extern USER_EXITS_API int USER_end_import_of_item(
    tag_t                 item_tag      
    );

extern USER_EXITS_API int USER_ecm_get_prev_bvr(
    tag_t                 ec_rev_tag,       
    tag_t                 bvr_tag,          
    tag_t*                prev_bvr_tag      
    );

extern 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       
    );

extern 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      
    );

extern USER_EXITS_API int USER_ecm_get_process_name(
    tag_t                 change_rev_tag,   
    int                   n_targets,        
    tag_t*                targets,          
    char**                process_name      
    );

extern USER_EXITS_API int USER_build_notify_message(
    const TcSubscriptionActionMsg_t*    theSubscriptionMsg,     
    char**                              messageSubject,         
    int*                                nMessageLines,          
    char***                             messageLines            
    );

extern USER_EXITS_API int USER_build_notify_message_with_locale(
    const TcSubscriptionActionMsg_t*    theSubscriptionMsg,     
    const char*                         localeStr,               
    char**                              messageSubject,         
    int*                                nMessageLines,          
    char***                             messageLines            
    );

extern USER_EXITS_API int USER_add_canned_methods( void );

extern USER_EXITS_API int USER_synchronize_baseline(
    const char*           fullFilePathName 
    );

extern USER_EXITS_API int USER_baseline_dryrun_validator(
    const char*           baseRevListFullFileName 
    );

extern USER_EXITS_API int USER_appr_item_is_above_ERCT(
    tag_t                 appr_context, 
    tag_t                 item_tag,     
    logical*              is_above_erct 
    );

extern 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             
    );

extern 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    
    );

extern 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                
    );

extern USER_EXITS_API int USER_ask_display_revisions(
    tag_t                 item_tag,     
    int*                  count,        
    tag_t**               revisions     
    );

extern 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          
    );

extern 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                
    );

extern 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            
    );

extern USER_EXITS_API int USER_is_item_rev_mature(
    tag_t                 item_rev_tag,     
    logical*              mature            
    );

extern USER_EXITS_API int USER_make_design_rev_primary_precond (
    tag_t               part_rev,           
    tag_t               design_rev,         
    logical*            isDesignRevEligible 
    );

extern USER_EXITS_API int USER_register_plmxml_filters();

extern USER_EXITS_API int USER_register_plmxml_schema_mappings();

extern USER_EXITS_API int USER_register_plmxml_actions();

extern USER_EXITS_API int USER_register_tcplmxml_filters();

extern USER_EXITS_API int USER_register_tcplmxml_actions();

extern USER_EXITS_API int USER_register_aiws_extensions();
extern USER_EXITS_API int USER_register_plmxml_import_methods();
extern USER_EXITS_API int USER_register_plmxml_export_methods();


extern USER_EXITS_API int USER_register_report_columns(void);

extern USER_EXITS_API logical USER_report_include_row(
    tag_t                     pff_tag, 
    int                       n_tags,  
    tag_t*                    obj_tags 
    );

extern USER_EXITS_API int USER_evaluate_compound_result(
    char*                 validation_name,      
    int                   validation_status,    
    logical*              validation_result     
    );

extern USER_EXITS_API int USER_validation_post_action(
    tag_t                 target,
    logical               validation_result,
    int                   validation_status
    );

extern USER_EXITS_API int TCHANDLER_proxy_link(
    void*                 subMsg,
    int                   nRecipients,
    char**                recipientList
    );

extern USER_EXITS_API int USER_get_batch_meshing_nr_name
(
    const char *meshFileName,                           /* <I> file name into which to encode mesh size */
    const char *meshSize,                               /* <I> mesh size to encode */
    const char *meshFileExt,                            /* <I> file name extension */
    char        namedRefName[IMF_filename_size_c + 1]   /* <O> resulting named ref name */
);

extern USER_EXITS_API int USER_get_batch_meshing_nr_name2
(
    const char *meshFileName,                           /* <I> file name into which to encode mesh size */
    const char *meshSize,                               /* <I> mesh size to encode */
    const char *meshFileExt,                            /* <I> file name extension */
    char        **namedRefName                          /* <OF> resulting named ref name */
);

extern USER_EXITS_API int USER_ods_client_publish_extra_attributes(
    tag_t       object_to_publish,                      /* <I> Selected object to be published*/
    int         n_attrs,                                /* <I> Number of extended attributed to be populated on PubR*/
    char**      pr_pom_attr_names,                      /* <I> Attribute names on PubR to be added */
    char*       attr_values[]                           /* <O> Attribute values on PubR to be added */
    );

extern USER_EXITS_API int USER_ods_client_ask_extra_attributes(
    int*        n_attrs,                                /* <O> Number of extended attributed to be populated on PubR*/
    char***     pr_pom_attr_names,                      /* <OF> Attribute names on PubR to be added */
    char***     attr_options                            /* <OF> Attribute options on PubR to be added */
    );

extern USER_EXITS_API int USER_classification_autocompute_attr();

extern USER_EXITS_API int USER_compute_effectivity(
    tag_t blTag,                                /* <I> BOMLine tag*/
    logical intersectConfigEff,                /* <I> If true Occ Effectivity(netEffObjTags) is intersection of
                                                       BOMLine Eff with Effectivity on BOMWindow Configuration */
    logical *occEffExists,                      /* <O> true if the occurrence has effectivity defined. */
    logical *isConfigured,                      /* <O> true if the occurrence is configured. */
    int *effyCount,                             /* <O> Occurrence Effectivity count*/
    WSOM_effectivity_info_t*** effectivityInfo   /* <OF>Occurrence Effectivity */
    );

extern USER_EXITS_API int USER_validate_id( 
    char* boType,                                           /* <I> The type name */
    int nKey,                                               /* <I> Number of MFK key */
    char **keys,                                            /* <I> List of MFK keys */
    char **values,                                          /* <I> List of MKF vlaues */
    logical* isValid                                        /* <O> The result of ID validation */
    );

extern 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                                             
    );


#ifdef __cplusplus
}
#endif

#include <user_exits/libuser_exits_undef.h>
#endif