ITK Function Reference
(V10000.1.0.60_20160308.00)
tie.h
Go to the documentation of this file.
1 /*==============================================================================
2  Copyright (c) 2006 UGS
3  Unpublished - All Rights Reserved
4  ==============================================================================*/
5 
12 #ifndef TIE_H
13 #define TIE_H
14 
15 #include <tccore/tctype.h>
16 #include <pie/pie.h>
17 #include <tc/tc_startup.h>
18 #include <tccore/workspaceobject.h>
19 #include <tie/tie_errors.h>
20 
21 #include <tie/libtie_exports.h>
22 
52 /**************************************************************
53  * NOTE:
54  * -----------------------------------------------------------
55  * If new status is added make sure to add it in
56  * TIE___addProcessedObjectToLog method. Also be careful while
57  * adding the numbers. It should be in sequence.
58  **************************************************************/
59 typedef enum Object_status_in_map_e
60 {
61  /**************************************************************
62  * NOTE:
63  * If new status is added, make sure to add it in the end of this list.
64  * Update the new status in TIE___addProcessedObjectToLog() method also.
65  **************************************************************/
66  TIE_NOCOMMENT = 0,
67  TIE_NEW ,
68  TIE_UPDATE ,
69  TIE_DELETE ,
70  TIE_FAILED ,
71  TIE_SKIPPED ,
72  TIE_REPLACED ,
73  TIE_STUBBED ,
74  TIE_OWNPASSED ,
75  TIE_OWNFAILED ,
76  TIE_DELETEFAILED ,
77  TIE_CHECKINFAILED ,
78  TIE_NOTOWNCHECKOUT ,
79  TIE_ROLLINGBACK ,
80  TIE_UNPROCESSED ,
81  TIE_INITIALIZED ,
82  TIE_NEWUNPROCESSED ,
83  TIE_PREPROCESSED ,
84  TIE_UPDATEUNPROCESSED ,
85  TIE_NEWTOBEPROCESSED ,
86  TIE_UPDATETOBEPROCESSED ,
87  TIE_REPLACESTUBWITHNEW ,
88  TIE_UPDATEWITHSITECO ,
89  TIE_UPDATEWITHOWNERSHIPCHANGE ,
90  TIE_OCCDELETE ,
91  TIE_GRMDELETE ,
92  TIE_ITEMREVDELETE ,
93  TIE_NAMEDREFDELETE ,
94  TIE_DUPLICATEGSID ,
95  TIE_OBJECTCREATEDASHELPER,
96  TIE_COEOWNFAILED,
97  PRIMARY_FAILED,
98  TIE_NAMEDREFREPLACED,
99  TIE_UNMANAGED_SKIP,
100  TIE_UNMANAGED_NEW,
101  TIE_UNMANAGED_UPDATE,
102  TIE_UNMANAGED_UNKNOWN
103 } Object_status_in_map_t;
104 
108 typedef enum Scope_rules_import_mode_e
109 {
110  UNDEFINED_MODE = 0,
111  IGNORE_MODE = 1,
112  OVERWRITE_MODE = 2,
113  APPEND_MODE = 3
114 } Scope_rules_import_mode_t;
115 
119 typedef enum TIE_cfg_delta_status_e
120 {
121  BL_DELTA_STATUS_SKIP,
122  BL_DELTA_STATUS_MODIFY,
123  BL_DELTA_STATUS_ADD,
124  BL_DELTA_STATUS_DELETE
125 } TIE_cfg_delta_status_t;
126 
130 typedef struct TIE_output_data_s
131 {
132  char *xmlFilePath;
133  char *importexport_log_fmsticket;
134  char *failedobjects_fmsticket;
137  int nRootObjs;
138  tag_t* rootObjs;
139  int nNewObjs;
140  tag_t* newObjs;
141  int nUpdatedObjs;
142  tag_t* updatedObjs;
143  int nDeletedObjsGSIdentities;
144  char** deletedObjsGSIdentities;
145 }TIE_output_data_t;
146 
150 typedef struct TIE_option_values_s
151 {
152  char *name;
153  char *value;
154 } TIE_option_value_t;
155 
156 typedef struct TIE_transfer_formula_s
157 {
158  char *optionSetName;
159  char *optionSetUid;
160  int n_options;
161  TIE_option_value_t *optionOverrides;
162  int n_sessOptions;
163  TIE_option_value_t *sessionOptions;
164  char *transferModeName;
165  char *transferModeUid;
166  char *logFileName;
167  char *logFilePath;
168  char *xsltFMSTicket;
169  char *reason;
170 } TIE_transfer_formula_t;
171 
172 typedef struct ownershipChange_s
173 {
174  int destinationSiteId;
175  int gsidCnt;
176  char** gsidStrs;
177 } ownershipChange_t;
178 
179 typedef struct stubInfo_s
180 {
181  int masterSiteId;
182  int gsidCnt;
183  char** gsidStrs;
184 } stubInfo_t;
185 
186 typedef struct locale_data_s
187 {
188  tag_t obj;
189  int nProps;
190  char** propNames;
191  char** propValues;
192 } locale_data_t;
193 
194 typedef struct TIEGSIdentityInput_s
195 {
196  char* system;
197  char* label;
198  char* subLabel;
199  char* className;
200  char* split_token;
201  char* context;
202  char* object_uid;
203  char* factor_id;
204  logical atomic;
205 } TIEGSIdentityInput_t;
206 
210 typedef enum TIE_export_status_e
211 {
212  EXPORT_SUCCESS,
213  EXPORT_SUCCESS_STUB,
214  EXPORT_PENDING,
215  EXPORT_PENDING_STUB,
216  EXPORT_PENDING_TRANSFER_OWNER,
217  EXPORT_FAIL,
218  EXPORT_REPLICA_DELETED,
219  EXPORT_CONVERT_TO_STUB,
220  EXPORT_SITE_CHECKIN,
221  EXPORT_PENDING_SITE_CHECKIN_DELETE,
222  EXPORT_MAX_STATUS
223 } TIE_export_status_t;
224 
228 typedef struct TIE_traversed_object_s
229 {
230  tag_t primary_tag;
231  tag_t secondary_tag;
232  PIE_connection_type_t relation_type;
233  char *relation_name;
234  tag_t relation_tag;
235  int rule_number;
236  logical new_island;
237 } TIE_traversed_object_t;
238 
239 #define TIE_serialize_msg "TIE_serialize"
240 #define TIE_deserialize_msg "TIE_deserialize"
241 
245 #define TIE_filter_lines_to_traverse_msg "TIE_filter_lines_to_traverse"
246 
247 #ifdef __cplusplus
248  extern "C"{
249 #endif
250 
251 
255 extern TIE_API int TIE_export_objects(
256  const char *tcGSMessageId,
257  int n_objects,
258  tag_t* objects,
259  int n_siteTags,
260  tag_t* targetSiteTags,
261  logical synchronize,
262  TIE_transfer_formula_t opts,
263  TIE_output_data_t* output_data
264  );
265 
269 extern TIE_API int TIE_traverse_objects(
270  const char *tcGSMessageId,
271  int n_objects,
272  tag_t* objects,
273  int n_siteTags,
274  tag_t* targetSiteTags,
275  logical synchronize,
276  TIE_transfer_formula_t opts,
277  TIE_output_data_t* output_data
278  );
279 
283 extern TIE_API int TIE_confirm_export(
284  tag_t targetSiteTag,
285  const char *tcGSMessageId,
286  int n_failed_objects,
287  tag_t* failed_objects,
288  logical commit,
289  int *n_ownership,
290  ownershipChange_t** ownership,
291  int *n_stubs,
292  stubInfo_t** stubs
293  );
294 
298 extern TIE_API int TIE_import_objects(
299  const char *transaction_id,
300  tag_t master_site,
301  TIE_transfer_formula_t opts,
302  char* input_xml_file,
303  TIE_output_data_t* output_data
304  );
305 
309 extern TIE_API int TIE_get_object_from_mesg(
310  void* tieGenMesg,
311  tag_t* objectTag
312  );
313 
317 extern TIE_API int TIE_get_preconstructed_uids(
318  int numRequestedUids,
319  int* numConstructedUids,
320  char*** constructedUids
321 );
322 
326 extern TIE_API int TIE_get_hashed_uid(
327  int ownSiteId,
328  const char* hashKey,
329  char** hashedUID
330 );
331 
335 extern TIE_API int TIE_create_gsidentities(
336  int numInput,
337  TIEGSIdentityInput_t* input,
338  int* numGSIDTags,
339  tag_t** gsidTags
340 );
341 
347 typedef int (* TIE_user_action_func_t)( tag_t );
348 
349 extern TIE_API int TIE_register_user_action (
350  char* handleName,
351  TIE_user_action_func_t user_m
352  );
353 
354 
358 typedef PIE_rule_type_t (* TIE_user_filter_func_t)( void *);
359 
360 extern TIE_API int TIE_register_user_filter (
361  char* filterRuleName,
362  TIE_user_filter_func_t user_m
363  );
364 
365 extern TIE_API int TIE_get_L10N_properties (
366  tag_t sessTag,
367  int nObjs,
368  tag_t* objTags,
369  locale_data_t **L10NProps
370  );
371 
376 extern TIE_API int TIE_lowlevel_confirm_import(
377  const char *tcGSMessageId,
378  int nSucessIslands,
379  char **sucessIslands,
380  int nFailureIslands,
381  char **failureIslands);
388 extern TIE_API int TIE_lowlevel_confirm_import_with_file(
389  const char *tcGSMessageId,
390  int nSucessIslands,
391  char **sucessIslands,
392  int nFailureIslands,
393  char **failureIslands,
394  TIE_output_data_t* output_data);
400 extern TIE_API int TIE_flip_ownership(
401  const char *tcGSMessageId,
402  int n_siteTags,
403  tag_t* targetSiteTags,
404  TIE_output_data_t* output_data,
405  logical isFlipDryRun);
417 extern TIE_API int TIE_filter_lines_to_traverse(
418  int n_lines,
419  const tag_t* bomlines,
420  const TIE_cfg_delta_status_t* line_delta_status,
421  logical** directive,
428  logical* user_exit_defined
429  );
430 
431 #ifdef __cplusplus
432 }
433 #endif
434 
435 #include <tie/libtie_undef.h>
436 
437 #endif
438