tie/tie.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2006 UGS
                Unpublished - All Rights Reserved
 ==============================================================================*/

#ifndef TIE_H
#define TIE_H

#include <tccore/tctype.h>
#include <pie/pie.h>
#include <tc/tc_startup.h>
#include <tccore/workspaceobject.h>
#include <tie/tie_errors.h>

#include <tie/libtie_exports.h>

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

/**************************************************************
 * NOTE:
 * -----------------------------------------------------------
 * If new status is added make sure to add it in
 * TIE___addProcessedObjectToLog method. Also be careful while
 * adding the numbers. It should be in sequence.
 **************************************************************/
typedef enum Object_status_in_map_e
{
    /**************************************************************
    * NOTE:
    * If new status is added, make sure to add it in the end of this list.
    * Update the new status in TIE___addProcessedObjectToLog() method also.
    **************************************************************/
    TIE_NOCOMMENT         = 0,
    TIE_NEW                  ,
    TIE_UPDATE               ,
    TIE_DELETE               ,
    TIE_FAILED               ,
    TIE_SKIPPED              ,
    TIE_REPLACED             ,
    TIE_STUBBED              ,
    TIE_OWNPASSED            ,
    TIE_OWNFAILED            ,
    TIE_DELETEFAILED         ,
    TIE_CHECKINFAILED        ,
    TIE_NOTOWNCHECKOUT       ,
    TIE_ROLLINGBACK          ,
    TIE_UNPROCESSED          ,
    TIE_INITIALIZED          ,
    TIE_NEWUNPROCESSED       ,
    TIE_PREPROCESSED         ,
    TIE_UPDATEUNPROCESSED    ,
    TIE_NEWTOBEPROCESSED     ,
    TIE_UPDATETOBEPROCESSED ,
    TIE_REPLACESTUBWITHNEW  ,
    TIE_UPDATEWITHSITECO    ,
    TIE_UPDATEWITHOWNERSHIPCHANGE ,
    TIE_OCCDELETE         ,
    TIE_GRMDELETE         ,
    TIE_ITEMREVDELETE     ,
    TIE_NAMEDREFDELETE    ,
    TIE_DUPLICATEGSID     ,
    TIE_OBJECTCREATEDASHELPER,
    TIE_COEOWNFAILED,
    PRIMARY_FAILED,
    TIE_NAMEDREFREPLACED,
    TIE_UNMANAGED_SKIP,
    TIE_UNMANAGED_NEW,
    TIE_UNMANAGED_UPDATE,
    TIE_UNMANAGED_UNKNOWN
} Object_status_in_map_t;

typedef enum Scope_rules_import_mode_e
{
    UNDEFINED_MODE = 0,
    IGNORE_MODE    = 1,     //Ignores already existing scope rules during import
    OVERWRITE_MODE = 2,     //Overwrites already existing scope rules during import
    APPEND_MODE = 3         //Appends clauses to already existing closure rules during import
} Scope_rules_import_mode_t;

typedef struct TIE_output_data_s
{
    char *xmlFilePath;
    char *importexport_log_fmsticket;              /* FMS Ticket of log file */
    char *failedobjects_fmsticket;                 /* FMS Ticket of failed objects xml file used*/
                                                   /* Used for importer only. For exporter this */
                                                   /* field is null */
    int    nRootObjs;
    tag_t* rootObjs;
    int    nNewObjs;
    tag_t* newObjs;
    int    nUpdatedObjs;
    tag_t* updatedObjs;
    int    nDeletedObjsGSIdentities;
    char** deletedObjsGSIdentities;
}TIE_output_data_t;

// Below structure can hold a generic name-value pair of
// strings
typedef struct TIE_option_values_s
{
    char *name;
    char *value;
} TIE_option_value_t;

typedef struct TIE_transfer_formula_s
{
    char *optionSetName;               /* Name of optionset */
    char *optionSetUid;                /* UID of optionset or null */
    int  n_options;                    /* Number of options */
    TIE_option_value_t *optionOverrides; /* Reference to the option overrides structure*/
    int  n_sessOptions;                /* Number of session options */
    TIE_option_value_t *sessionOptions;  /* Reference to the session options structure*/
    char *transferModeName;            /* Name of Transfermode */
    char *transferModeUid;             /* UID of Transfermode or null */
    char *logFileName;               /* File name for log output or null */
    char *logFilePath;               /* File path for log output or null */
    char   *xsltFMSTicket;             /* FMS File ticket for xslt file    */
    char *reason;                      /* Reason string */
} TIE_transfer_formula_t;

typedef struct ownershipChange_s
{
    int    destinationSiteId;     /* Destination site */
    int    gsidCnt;               /* Number of object Gsid Strings */
    char** gsidStrs;              /* Object Gsid strings */
} ownershipChange_t;

typedef struct stubInfo_s
{
    int    masterSiteId;          /* Master site */
    int    gsidCnt;               /* Number of object Gsid Strings */
    char** gsidStrs;              /* Object Gsid strings */
} stubInfo_t;

typedef struct locale_data_s
{
    tag_t  obj;             //tc object
    int    nProps;          //number of locale contents
    char** propNames;       //L10N attribute names
    char** propValues;      //L10N attribute values
} locale_data_t;

typedef struct TIEGSIdentityInput_s
{
    char* system;
    char*  label;
    char*  subLabel;
    char*  className;
    char*  split_token;
    char*  context;
    char*  object_uid;
    char*  factor_id;
    logical atomic;
} TIEGSIdentityInput_t;

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

#define TIE_serialize_msg       "TIE_serialize"
#define TIE_deserialize_msg     "TIE_deserialize"

#ifdef __cplusplus
    extern "C"{
#endif


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

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

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

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

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

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

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

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

typedef int (* TIE_user_action_func_t)( tag_t );

extern TIE_API int TIE_register_user_action (
  char*                      handleName,    
  TIE_user_action_func_t     user_m         
  );


typedef PIE_rule_type_t (* TIE_user_filter_func_t)( void *);

extern TIE_API int TIE_register_user_filter (
  char*          filterRuleName,    
  TIE_user_filter_func_t user_m     
  );

extern TIE_API int TIE_get_L10N_properties (
  tag_t          sessTag,  
  int            nObjs,                    
  tag_t*         objTags,                  
  locale_data_t  **L10NProps               
  );

extern TIE_API int TIE_lowlevel_confirm_import(
    const char       *tcGSMessageId,         
    int               nSucessIslands,        
    char            **sucessIslands,         
    int               nFailureIslands,       
    char            **failureIslands);       
extern TIE_API int TIE_lowlevel_confirm_import_with_file(
    const char       *tcGSMessageId,         
    int               nSucessIslands,        
    char            **sucessIslands,         
    int               nFailureIslands,       
    char            **failureIslands,        
    TIE_output_data_t* output_data);         
extern TIE_API int TIE_flip_ownership(
    const char *tcGSMessageId,       
    int n_siteTags,                  
    tag_t* targetSiteTags,           
    TIE_output_data_t* output_data,  
    logical isFlipDryRun);           
#ifdef __cplusplus
}
#endif

#include <tie/libtie_undef.h>

#endif

---