ITK Function Reference

(V10000.1.0.60_20160308.00)
Data Structures | Macros | Typedefs | Enumerations | Functions
tie.h File Reference
#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>
#include <tie/libtie_undef.h>

Go to the source code of this file.

Data Structures

struct  locale_data_s
 
struct  ownershipChange_s
 
struct  stubInfo_s
 
struct  TIE_option_values_s
 
struct  TIE_output_data_s
 
struct  TIE_transfer_formula_s
 
struct  TIE_traversed_object_s
 
struct  TIEGSIdentityInput_s
 

Macros

#define TIE_deserialize_msg   "TIE_deserialize"
 
#define TIE_filter_lines_to_traverse_msg   "TIE_filter_lines_to_traverse"
 
#define TIE_serialize_msg   "TIE_serialize"
 

Typedefs

typedef struct locale_data_s locale_data_t
 
typedef enum Object_status_in_map_e Object_status_in_map_t
 
typedef struct ownershipChange_s ownershipChange_t
 
typedef enum
Scope_rules_import_mode_e 
Scope_rules_import_mode_t
 
typedef struct stubInfo_s stubInfo_t
 
typedef enum TIE_cfg_delta_status_e TIE_cfg_delta_status_t
 
typedef enum TIE_export_status_e TIE_export_status_t
 
typedef struct TIE_option_values_s TIE_option_value_t
 
typedef struct TIE_output_data_s TIE_output_data_t
 
typedef struct
TIE_transfer_formula_s 
TIE_transfer_formula_t
 
typedef struct
TIE_traversed_object_s 
TIE_traversed_object_t
 
typedef int(* TIE_user_action_func_t )(tag_t)
 
typedef PIE_rule_type_t(* TIE_user_filter_func_t )(void *)
 
typedef struct TIEGSIdentityInput_s TIEGSIdentityInput_t
 

Enumerations

enum  Object_status_in_map_e {
  TIE_NOCOMMENT = 0, TIE_NEW, TIE_UPDATE, TIE_DELETE,
  TIE_FAILED, TIE_SKIPPED, TIE_REPLACED, TIE_STUBBED,
  TIE_OWNPASSED, TIE_OWNFAILED, TIE_DELETEFAILED, TIE_CHECKINFAILED,
  TIE_NOTOWNCHECKOUT, TIE_ROLLINGBACK, TIE_UNPROCESSED, TIE_INITIALIZED,
  TIE_NEWUNPROCESSED, TIE_PREPROCESSED, TIE_UPDATEUNPROCESSED, TIE_NEWTOBEPROCESSED,
  TIE_UPDATETOBEPROCESSED, TIE_REPLACESTUBWITHNEW, TIE_UPDATEWITHSITECO, TIE_UPDATEWITHOWNERSHIPCHANGE,
  TIE_OCCDELETE, TIE_GRMDELETE, TIE_ITEMREVDELETE, TIE_NAMEDREFDELETE,
  TIE_DUPLICATEGSID, TIE_OBJECTCREATEDASHELPER, TIE_COEOWNFAILED, PRIMARY_FAILED,
  TIE_NAMEDREFREPLACED, TIE_UNMANAGED_SKIP, TIE_UNMANAGED_NEW, TIE_UNMANAGED_UPDATE,
  TIE_UNMANAGED_UNKNOWN
}
 
enum  Scope_rules_import_mode_e { UNDEFINED_MODE = 0, IGNORE_MODE = 1, OVERWRITE_MODE = 2, APPEND_MODE = 3 }
 
enum  TIE_cfg_delta_status_e { BL_DELTA_STATUS_SKIP, BL_DELTA_STATUS_MODIFY, BL_DELTA_STATUS_ADD, BL_DELTA_STATUS_DELETE }
 
enum  TIE_export_status_e {
  EXPORT_SUCCESS, EXPORT_SUCCESS_STUB, EXPORT_PENDING, EXPORT_PENDING_STUB,
  EXPORT_PENDING_TRANSFER_OWNER, EXPORT_FAIL, EXPORT_REPLICA_DELETED, EXPORT_CONVERT_TO_STUB,
  EXPORT_SITE_CHECKIN, EXPORT_PENDING_SITE_CHECKIN_DELETE, EXPORT_MAX_STATUS
}
 

Functions

TIE_API int TIE_confirm_export (tag_t targetSiteTag, const char *tcGSMessageId, int n_failed_objects, tag_t *failed_objects, logical commit, int *n_ownership, ownershipChange_t **ownership, int *n_stubs, stubInfo_t **stubs)
 
TIE_API int TIE_create_gsidentities (int numInput, TIEGSIdentityInput_t *input, int *numGSIDTags, tag_t **gsidTags)
 
TIE_API int TIE_export_objects (const char *tcGSMessageId, int n_objects, tag_t *objects, int n_siteTags, tag_t *targetSiteTags, logical synchronize, TIE_transfer_formula_t opts, TIE_output_data_t *output_data)
 
TIE_API int TIE_filter_lines_to_traverse (int n_lines, const tag_t *bomlines, const TIE_cfg_delta_status_t *line_delta_status, logical **directive, logical *user_exit_defined)
 
TIE_API int TIE_flip_ownership (const char *tcGSMessageId, int n_siteTags, tag_t *targetSiteTags, TIE_output_data_t *output_data, logical isFlipDryRun)
 
TIE_API int TIE_get_hashed_uid (int ownSiteId, const char *hashKey, char **hashedUID)
 
TIE_API int TIE_get_L10N_properties (tag_t sessTag, int nObjs, tag_t *objTags, locale_data_t **L10NProps)
 
TIE_API int TIE_get_object_from_mesg (void *tieGenMesg, tag_t *objectTag)
 
TIE_API int TIE_get_preconstructed_uids (int numRequestedUids, int *numConstructedUids, char ***constructedUids)
 
TIE_API int TIE_import_objects (const char *transaction_id, tag_t master_site, TIE_transfer_formula_t opts, char *input_xml_file, TIE_output_data_t *output_data)
 
TIE_API int TIE_lowlevel_confirm_import (const char *tcGSMessageId, int nSucessIslands, char **sucessIslands, int nFailureIslands, char **failureIslands)
 
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)
 
TIE_API int TIE_register_user_action (char *handleName, TIE_user_action_func_t user_m)
 
TIE_API int TIE_register_user_filter (char *filterRuleName, TIE_user_filter_func_t user_m)
 
TIE_API int TIE_traverse_objects (const char *tcGSMessageId, int n_objects, tag_t *objects, int n_siteTags, tag_t *targetSiteTags, logical synchronize, TIE_transfer_formula_t opts, TIE_output_data_t *output_data)
 

Detailed Description

Import Export functions

Definition in file tie.h.

Typedef Documentation

typedef int(* TIE_user_action_func_t)(tag_t)

External User action rule support

Definition at line 347 of file tie.h.

typedef PIE_rule_type_t(* TIE_user_filter_func_t)(void *)

External User filter rule support

Definition at line 358 of file tie.h.

Function Documentation

TIE_API int TIE_filter_lines_to_traverse ( int  n_lines,
const tag_t bomlines,
const TIE_cfg_delta_status_t line_delta_status,
logical **  directive,
logical user_exit_defined 
)

User exit to filter out the lines to traverse for indexing.
Custom implementation can be provided by registering with the message TIE_filter_lines_to_traverse_msg. All the BOMLines that need to be synchronized are passed in and the custom implementation has to update the directive values. Setting the directive as false means to skip the line for the traversal for indexing.

Returns
Parameters
n_lines(I) Number of lines identified for synchronization at a level
bomlines(I) n_lines BOMLines identified for synchronization at a level
line_delta_status(I) n_lines Delta status of the lines (Skip, Modify, Add, Delete)
directive(OF) n_lines Values set by the custom implementation of the message TIE_filter_lines_to_traverse_msg to indicate if each of the BOMLines are to be traversed or skipped for indexing.
The values are:
  • true: the line is to be traversed. This is the value returned if no customization is in place.
  • false: the line is not to be traversed.
user_exit_defined(O) Indicates if a custom code was executed.
TIE_API int TIE_flip_ownership ( const char *  tcGSMessageId,
int  n_siteTags,
tag_t targetSiteTags,
TIE_output_data_t output_data,
logical  isFlipDryRun 
)

performs high level ownership transfer (flip-the-switch)(I) Dryrun mode option

Parameters
tcGSMessageId(I) Unique id for transaction or NULL
n_siteTags(I) Number of sites to export to
targetSiteTags(I) n_siteTags Tags of target sites
output_data(I) Output data structure
TIE_API int TIE_get_L10N_properties ( tag_t  sessTag,
int  nObjs,
tag_t objTags,
locale_data_t **  L10NProps 
)
Parameters
nObjs< (I) Session
objTags< (I) number of objects
L10NProps< (I) Array of objects < (O) Array of Locale data
TIE_API int TIE_lowlevel_confirm_import ( const char *  tcGSMessageId,
int  nSucessIslands,
char **  sucessIslands,
int  nFailureIslands,
char **  failureIslands 
)

Confirm low level import and failure of objects

Deprecated:
This function is deprecated, Use TIE_lowlevel_confirm_import_with_file

(I) nFailureObjects Objects that failed to export

Parameters
tcGSMessageId(I) Unique id for transaction or NULL
nSucessIslands(I) Number of objects that exported successfully
sucessIslands(I) nSucessObjects Objects that exported Successfully
nFailureIslands(I) Number of objects that failed to export
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 
)

Confirm low level import and failure of objects

Note
Starting tc10.1.4, ACCT_TABLE was upgraded with app_id. This method is only for site consolidation usage.
The method takes ":SITECON_SYNC" as app_id when updating ACCT_TABLE.(I) Output data structure
Parameters
tcGSMessageId(I) Unique id for transaction or NULL
nSucessIslands(I) Number of objects that exported successfully
sucessIslands(I) nSucessObjects Objects that exported Successfully
nFailureIslands(I) Number of objects that failed to export
failureIslands(I) nFailureObjects Objects that failed to export
TIE_API int TIE_register_user_action ( char *  handleName,
TIE_user_action_func_t  user_m 
)
Parameters
handleName(I) Action name
user_m(I) Action method
TIE_API int TIE_register_user_filter ( char *  filterRuleName,
TIE_user_filter_func_t  user_m 
)
Parameters
filterRuleName(I) Filter name
user_m(I) Filter method