ITK Function Reference
(V10000.1.0.60_20160308.00)
crf.h
Go to the documentation of this file.
1 /*==============================================================================
2  Copyright (c) 2003-2005 UGS Corporation
3  Unpublished - All Rights Reserved
4  ==============================================================================*/
5 
6 /* */
7 
8 #ifndef CRF_H
9 #define CRF_H
10 
11 #include <tc/tc_startup.h>
12 #include <ss/ss_const.h>
13 #include <pie/pie.h>
14 
15 #include <qry/libqry_exports.h>
16 
17 #define CRF_REP_name_size_c 128
18 #define CRF_REP_desc_size_c 512
19 #define CRF_REP_id_size_c 32
20 #define CRF_REP_source_size_c 32
21 #define CRF_REP_class_size_c 32
22 #define CRF_REP_folder_name_size_c 32
23 
24 #define XML_REPORT_FORMATTER "XMLReportFormatter" /*TODO delete me.*/
25 
26 #define CRF_XML_STYLESHEET "CrfXmlStylesheet"
27 #define CRF_HTML_STYLESHEET "CrfHtmlStylesheet"
28 #define CRF_EXCEL_STYLESHEET "CrfExcelStylesheet"
29 #define CRF_TEXT_STYLESHEET "CrfTextStylesheet"
30 #define CRF_PDF_STYLESHEET "CrfPdfStylesheet"
31 #define CRF_MSWORD_STYLESHEET "CrfMSWordDocStylesheet"
32 #define CRF_NEWEXCEL_STYLESHEET "MSExcelX"
33 #define CRF_NEWMSWORD_STYLESHEET "MSWordX"
34 
35 #define CRF_DEFAULT_REPORT_EXTENSION ".xml"
36 #define CRF_HTML_EXTENSION ".html"
37 #define CRF_EXCEL_EXTENSION ".xls"
38 #define CRF_EXCEL_OOXML_EXTENSION ".xlsx"
39 #define CRF_PDF_EXTENSION ".pdf"
40 #define CRF_TEXT_EXTENSION ".txt"
41 #define CRF_MSWORD_EXTENSION ".doc"
42 #define CRF_NEWEXCEL_EXTENSION ".xlsm"
43 #define CRF_NEWWORD_EXTENSION ".docm"
44 
45 
46 #define CRF_OUTPUT_HTML_DATASET_TYPES "CrfOutputHtml"
47 #define CRF_OUTPUT_EXCEL_DATASET_TYPES "CrfOutputExcel"
48 #define CRF_OUTPUT_XML_DATASET_TYPES "CrfOutputXml"
49 #define CRF_OUTPUT_PDF_DATASET_TYPES "CrfOutputPdf"
50 #define CRF_OUTPUT_TEXT_DATASET_TYPES "CrfOutputText"
51 #define CRF_OUTPUT_MSWORD_DATASET_TYPES "CrfOutputMSWord"
52 
53 
54 #define CRF_OUTPUT_HTML_NAMED_REF "HTML"
55 #define CRF_OUTPUT_EXCEL_NAMED_REF "excel"
56 #define CRF_OUTPUT_XML_NAMED_REF "XML"
57 #define CRF_OUTPUT_PDF_NAMED_REF "PDF"
58 #define CRF_OUTPUT_TEXT_NAMED_REF "Text"
59 #define CRF_OUTPUT_MSWORD_NAMED_REF "word"
60 
61 #define XSL_REF "XSL"
62 
63 #define urlServerPreference "WEB_default_site_server"
64 #define urlProtocolPref "WEB_protocol"
65 #define urlApplicationName "WEB_default_site_deployed_app_name"
66 #define NAME_PROP "object_name"
67 #define REP_LOCALE_STR "report_locale"
68 #define REP_LOCALE_VAL "en_US"
69 #define OFFICE_LIVE "OfficeLive"
70 #define BOM_REP_TYPE "BOMReport"
71 #define BOM_REP_CRITERIA "BOM_REPORT"
72 #define BOM_REP_CRITERIA_VAL "TRUE"
73 #define REP_NAME_STRING "report_name"
74 #define REV_RULE "REV_RULE"
75 #define ITEM_REP_TYPE "ItemReport"
76 #define URL_GEN_SUMMARY_REP "URLGenSummaryReport"
77 
78 /*TC release subrelease then rept type*/
79 #define CRF_SUM_REPORT_ID_PREFIX "TC_9_00_SUM_RPT_"
80 #define CRF_ITM_REPORT_ID_PREFIX "TC_9_00_ITM_RPT_"
81 #define CRF_CUS_REPORT_ID_PREFIX "TC_9_00_CUS_RPT_"
82 
83 #ifdef __cplusplus
84  extern "C"{
85 #endif
86 
87 typedef enum CRF_report_type_e {
88  CRF_REPORT_SUMMARY, /* summary report */
89  CRF_REPORT_ITEM_REPORT, /* item report */
90  CRF_REPORT_CUSTOM_REPORT, /* custom report */
91  CRF_ALL_REPORTS /* All reports */
92 } CRF_report_type_t;
93 
94 
95 typedef enum CRF_qry_source_type_e {
96  CRF_TC_QUERY,
97  CRF_TRANSFER_MODE
98 } CRF_qry_source_type_t;
99 
100 
104 extern QRY_API int CRF_create_report_definition(
105  const char* id,
106  const char* name,
107  const char* description,
108  const char* rpt_class,
109  int report_type,
110  const char* folder_name,
111  int state,
112  const char* source,
113  int no_of_params,
114  const char** rd_parameters,
115  const char** rd_values,
116  tag_t query_source,
117  tag_t property_source,
118  int no_style_sheets,
119  tag_t* style_sheets,
120  tag_t* report_definition
121  );
122 
126 extern QRY_API int CRF_get_report_definitions(
127  const char* reportId,
128  const char* reportName,
129  const char* category,
130  const char* source,
131  int status,
132  int no_of_context_objs,
133  tag_t* context_objects,
134  int* n_tags,
135  tag_t** report_definition_tags
136  );
137 
162 extern QRY_API int CRF_generate_report (
163  tag_t report_definition_tag,
164  tag_t stylesheet_tag,
165  int no_of_context_objs,
166  tag_t* context_objects,
167  int criteria_count,
168  char** criteria_names,
169  char** criteria_values,
170  char* data_set_name,
171  char** report_path_name
172  );
173 
174 /*
175  The function to generate a report. [With more parameters ]
176 */
177 extern QRY_API int CRF_generate_report_1 (
178  tag_t report_definition_tag,
179  char* report_name,
180  char* stylesheet_name,
181  tag_t stylesheet_tag,
182  int no_of_context_objs,
183  tag_t* context_objects,
184  int criteria_count,
185  char** criteria_names,
186  char** criteria_values,
187  char* data_set_name,
188  char* data_set_type,
189  char* relation_name,
190  tag_t context_object,
191  char** report_path_name
192  );
193 
194 /*
195  The function to generate a report. [With more parameters ]
196 */
197 extern QRY_API int CRF_generate_report_2 (
198  tag_t report_definition_tag,
199  char* report_name,
200  char* stylesheet_name,
201  tag_t stylesheet_tag,
202  int no_of_context_objs,
203  tag_t* context_objects,
204  int criteria_count,
205  char** criteria_names,
206  char** criteria_values,
207  char* data_set_name,
208  char* data_set_type,
209  char* relation_name,
210  tag_t context_object,
211  int report_options_count,
212  char** report_options_names,
213  char** report_options_values,
214  char** report_path_name
215  );
216 
220 extern QRY_API int CRF_generate_report_id (
221  const char* report_type_name,
222  char** report_id
223  );
224 
228 extern QRY_API int CRF_copy_report_to_transient_vol(
229  char* filepath ,
230  char** transientVolumeDir,
231  char** copiedFileName
232  );
233 
234 extern QRY_API int CRF_get_item_report_definitions_of_parentclass(
235  tag_t parent_class_id, /* (I) POM class tag */
236  int* n_tags,
237  tag_t** report_definition_tags
238  );
239 
251 extern QRY_API int CRF_generate_report_3(
252  char* report_definition_uid,
253  char* object_uid,
254  char* template_name,
255  char* rev_rule_uid,
256  logical isLive,
257  char* report_type,
258  char** file_path,
259  char** xml_string
260  );
261 
262 #ifdef __cplusplus
263 }
264 #endif
265 
266 #include <qry/libqry_undef.h>
267 
268 #endif