|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
Data Structures | |
| struct | REQ_importexport_options_t |
Macros | |
| #define | REQ_export_as_ms_word_markup "ReqMarkupMgmt" |
| #define | REQ_export_as_ms_word_markup_live "ReqMarkupMgmtFN" |
| #define | REQ_export_as_ms_word_xml "MSWordXML" |
| #define | REQ_export_as_ms_word_xml_live "MSWordXMLLive" |
| #define | REQ_export_as_structure_contents "StructureWithContents" |
| #define | REQ_url_application_name "WEB_default_site_deployed_app_name" |
| #define | REQ_url_protocol_preference "WEB_protocol" |
| #define | REQ_url_server_preference "WEB_default_site_server" |
Typedefs | |
| typedef enum REQ_content_types_e | REQ_content_types_t |
Enumerations | |
| enum | REQ_content_types_e { REQ_HTML, REQ_PLAINTEXT, REQ_RICHTEXT } |
Functions | |
| REQ_API int | REQ_collect_markups (int req_rev_count, const tag_t *req_rev_list, char **markup_file_path) |
| REQ_API int | REQ_excel_export (int object_count, const tag_t *objects, int attribute_count, const char **attributes, const char *template_name, const char *application_format, int export_option_count, const REQ_importexport_options_t *export_options, char **file_path) |
| REQ_API int | REQ_set_contents (tag_t rev_or_fulltext_tag, REQ_content_types_t content_type, const char *contents) |
| REQ_API int | REQ_word_export (int size, const tag_t *bom_lines, logical deep, int document_type, const char *specification_template, int object_template_count, const char **bo_type, const char **object_template, int export_option_count, const REQ_importexport_options_t *export_options, const char *mode_of_operation, char **document_location) |
| REQ_API int | USER_create_tracelink (const char *tracelink_type, const char *tracelink_direction, int parent_object_count, tag_t *parent_objects, int child_object_count, tag_t *child_objects) |
| C REQ_API int | USER_search (const char **property_names, const char **property_values, int property_count, int *object_count, tag_t **object_list) |
This file contains the function prototypes for working with the requirements class specifically with the C ITK interface to this class.
Requirements Management allows users to export the teamcenter objects to Microsoft Office applications like Word and Excel and allow them editing in live and offline mode. <br>It also provides functions to extract user defined markups in word document and store them in Teamcenter. Teamcenter makes use of this mechanism itself, and it also provides ITK level functions for programmers to make use of the same. <br>Programmers can define their own requirement codes if they wish, or they can write their own functions to export / import the objects. If you intend to add new requirement codes, we suggest that you prefix them with your company name, thus ensuring that they will not conflict with any requirement codes that Teamcenter may implement in the future.
The ITK requirements functions include:
To use these functions, include requirements.h.
| #define EIMP_attr_value_not_present (EMH_REQ_error_base + 92) |
Definition at line 100 of file req_errors.h.
| #define EIMP_empty_node_value (EMH_REQ_error_base + 96) |
Definition at line 104 of file req_errors.h.
| #define EIMP_form_element_absent (EMH_REQ_error_base + 102) |
Definition at line 110 of file req_errors.h.
| #define EIMP_GRM_element_absent (EMH_REQ_error_base + 103) |
Definition at line 111 of file req_errors.h.
| #define EIMP_GSI_xmlelement_not_found (EMH_REQ_error_base + 95) |
Definition at line 103 of file req_errors.h.
| #define EIMP_invalid_extension (EMH_REQ_error_base + 109) |
Definition at line 117 of file req_errors.h.
| #define EIMP_invalid_revision_id (EMH_REQ_error_base + 101) |
Definition at line 109 of file req_errors.h.
| #define EIMP_invalid_soa_output (EMH_REQ_error_base + 97) |
Definition at line 105 of file req_errors.h.
| #define EIMP_item_element_absent (EMH_REQ_error_base + 100) |
Definition at line 108 of file req_errors.h.
| #define EIMP_itemrevision_element_absent (EMH_REQ_error_base + 99) |
Definition at line 107 of file req_errors.h.
| #define EIMP_latest_revision_absent (EMH_REQ_error_base + 104) |
Definition at line 112 of file req_errors.h.
| #define EIMP_new_revision_not_supported (EMH_REQ_error_base + 108) |
Definition at line 116 of file req_errors.h.
| #define EIMP_no_object_to_process (EMH_REQ_error_base + 90) |
Definition at line 98 of file req_errors.h.
| #define EIMP_no_revision_type_present (EMH_REQ_error_base + 106) |
Definition at line 114 of file req_errors.h.
| #define EIMP_null_xmlelement_passed (EMH_REQ_error_base + 94) |
Definition at line 102 of file req_errors.h.
| #define EIMP_OCC_element_absent (EMH_REQ_error_base + 105) |
Definition at line 113 of file req_errors.h.
| #define EIMP_tempdir_notfound (EMH_REQ_error_base + 89) |
Definition at line 97 of file req_errors.h.
| #define EIMP_type_not_supported (EMH_REQ_error_base + 107) |
Definition at line 115 of file req_errors.h.
| #define EIMP_unknown_error (EMH_REQ_error_base + 88) |
Excel Import Error messages
Definition at line 96 of file req_errors.h.
| #define EIMP_xml_element_absent (EMH_REQ_error_base + 98) |
Definition at line 106 of file req_errors.h.
| #define EIMP_xmldoc_InitializeFailed (EMH_REQ_error_base + 91) |
Definition at line 99 of file req_errors.h.
| #define EIMP_xmlelement_creation_failed (EMH_REQ_error_base + 93) |
Definition at line 101 of file req_errors.h.
| #define EXP_createTransTicket_failed (EMH_REQ_error_base + 57) |
Definition at line 71 of file req_errors.h.
| #define EXP_filecreate_failed (EMH_REQ_error_base + 56) |
Definition at line 70 of file req_errors.h.
| #define EXP_invalid_objectType (EMH_REQ_error_base + 50) |
Definition at line 66 of file req_errors.h.
| #define EXP_invalid_transVolDir (EMH_REQ_error_base + 55) |
Definition at line 69 of file req_errors.h.
| #define EXP_lov_error (EMH_REQ_error_base + 52) |
Definition at line 68 of file req_errors.h.
| #define EXP_prop_metadata_not_found (EMH_REQ_error_base + 51) |
Definition at line 67 of file req_errors.h.
| #define FTX_bad_position (EMH_REQ_error_base + 22) |
Definition at line 38 of file req_errors.h.
| #define FTX_initialization_failed (EMH_REQ_error_base + 21) |
Unable to initialize FullText Attributes
Definition at line 37 of file req_errors.h.
| #define FTX_internal_error (EMH_REQ_error_base + 23) |
Definition at line 39 of file req_errors.h.
| #define REQ_access_denied (EMH_REQ_error_base + 5) |
Access to the object "%1$" is denied. Please refer to the Teamcenter server syslog file for more details.
Definition at line 34 of file req_errors.h.
| #define REQ_bad_param_empty_filename (EMH_REQ_error_base + 411) |
Definition at line 163 of file req_errors.h.
| #define REQ_bad_param_empty_string (EMH_REQ_error_base + 412) |
Definition at line 164 of file req_errors.h.
| #define REQ_bad_param_null_fileticket (EMH_REQ_error_base + 413) |
Definition at line 165 of file req_errors.h.
| #define REQ_bad_param_null_value (EMH_REQ_error_base + 414) |
Definition at line 166 of file req_errors.h.
| #define REQ_bad_param_nulltag (EMH_REQ_error_base + 410) |
Definition at line 162 of file req_errors.h.
| #define REQ_bad_parameter (EMH_REQ_error_base + 409) |
Definition at line 161 of file req_errors.h.
| #define REQ_bodytext_too_long (EMH_REQ_error_base + 304) |
The content of object "%1$" cannot be saved to the database, because it exceeds the maximum size of 5 MB. Please split this content onto two objects
Definition at line 148 of file req_errors.h.
| #define REQ_cannot_export_by_view (EMH_REQ_error_base + 45) |
Definition at line 60 of file req_errors.h.
| #define REQ_cannot_export_multisheet (EMH_REQ_error_base + 43) |
Definition at line 58 of file req_errors.h.
| #define REQ_cannot_export_packing_template (EMH_REQ_error_base + 46) |
Definition at line 61 of file req_errors.h.
| #define REQ_cannot_export_precise (EMH_REQ_error_base + 42) |
Definition at line 57 of file req_errors.h.
| #define REQ_cleartext_unavailable (EMH_REQ_error_base + 58) |
Definition at line 72 of file req_errors.h.
| #define REQ_content_object_not_found (EMH_REQ_error_base + 28) |
Definition at line 43 of file req_errors.h.
| #define REQ_create_markups_failed (EMH_REQ_error_base + 421) |
Definition at line 173 of file req_errors.h.
| #define REQ_customnote_already_associated (EMH_REQ_error_base + 79) |
Definition at line 85 of file req_errors.h.
| #define REQ_default_styles_template_not_found (EMH_REQ_error_base + 26) |
Definition at line 41 of file req_errors.h.
| #define REQ_delimiter_cannot_be_a_colon (EMH_REQ_error_base + 81) |
Definition at line 87 of file req_errors.h.
| #define REQ_duplicate_tags_found (EMH_REQ_error_base + 33) |
Definition at line 48 of file req_errors.h.
| #define REQ_EMP_Gen_handler_failed (EMH_REQ_error_base + 4) |
Definition at line 32 of file req_errors.h.
| #define REQ_EMP_SM_handler_failed (EMH_REQ_error_base + 3) |
Definition at line 31 of file req_errors.h.
| #define REQ_empty_columns_found (EMH_REQ_error_base + 200) |
Excel Export Error messages Range 200 to 300
Definition at line 123 of file req_errors.h.
| #define REQ_EPM_Handler_registration_failed (EMH_REQ_error_base + 2) |
Definition at line 30 of file req_errors.h.
| #define REQ_excel_checkout_warning (EMH_REQ_error_base + 207) |
Definition at line 133 of file req_errors.h.
| #define REQ_excel_duplicate_columns_found (EMH_REQ_error_base + 39) |
Definition at line 54 of file req_errors.h.
| #define REQ_excel_outline_limit_reimport (EMH_REQ_error_base + 202) |
MS Excel's outlining feature can only display up to 8 levels. Since this structure exceeds that number of levels, it will be exported as a flat list.
Since the generated sheet will not accurately represent the levels, it cannot be used for re-import.
Definition at line 128 of file req_errors.h.
| #define REQ_excel_outline_limit_static (EMH_REQ_error_base + 201) |
MS Excel's outlining feature can only display up to 8 levels. Since this structure exceeds that number of levels, it will be exported as a flat list.
Definition at line 125 of file req_errors.h.
| #define REQ_excel_tags_not_found (EMH_REQ_error_base + 32) |
Definition at line 47 of file req_errors.h.
| #define REQ_excel_template_dataset_not_found (EMH_REQ_error_base + 38) |
Definition at line 53 of file req_errors.h.
| #define REQ_excel_template_not_found (EMH_REQ_error_base + 30) |
Definition at line 45 of file req_errors.h.
| #define REQ_excel_template_revision_not_found (EMH_REQ_error_base + 37) |
Definition at line 52 of file req_errors.h.
| #define REQ_export_as_ms_word_markup "ReqMarkupMgmt" |
Defines the mode used to specify the operation to export the word document as a markup word document.
Definition at line 67 of file requirement.h.
| #define REQ_export_as_ms_word_markup_live "ReqMarkupMgmtFN" |
Defines the mode used to specify the operation to export the word document as a markup live word report.
Definition at line 69 of file requirement.h.
| #define REQ_export_as_ms_word_xml "MSWordXML" |
Defines the mode used to specify the operation to export the word document as a static report.
Definition at line 61 of file requirement.h.
| #define REQ_export_as_ms_word_xml_live "MSWordXMLLive" |
Defines the mode used to specify the operation to export the word document as a live word document.
Definition at line 63 of file requirement.h.
| #define REQ_export_as_structure_contents "StructureWithContents" |
Defines the mode used to specify the operation to export the word document as a structured and live word document.
Definition at line 65 of file requirement.h.
| #define REQ_export_template_inavlid_type (EMH_REQ_error_base + 29) |
Definition at line 44 of file req_errors.h.
| #define REQ_external_references_found (EMH_REQ_error_base + 206) |
Definition at line 132 of file req_errors.h.
| #define REQ_failed_to_create_markup_dataset (EMH_REQ_error_base + 405) |
Definition at line 157 of file req_errors.h.
| #define REQ_failed_to_find_markup_dataset_type (EMH_REQ_error_base + 404) |
Definition at line 156 of file req_errors.h.
| #define REQ_failed_to_get_class_id (EMH_REQ_error_base + 403) |
Definition at line 155 of file req_errors.h.
| #define REQ_flat_file_object_not_found (EMH_REQ_error_base + 502) |
The object "%1$" cannot be found in the database.
Definition at line 189 of file req_errors.h.
| #define REQ_flatlist_not_supported (EMH_REQ_error_base + 49) |
Definition at line 64 of file req_errors.h.
| #define REQ_footer_not_supported (EMH_REQ_error_base + 48) |
Definition at line 63 of file req_errors.h.
| #define REQ_gather_markups_failed (EMH_REQ_error_base + 402) |
Definition at line 154 of file req_errors.h.
| #define REQ_get_child_element_failed (EMH_REQ_error_base + 451) |
PIE error messages Range 451 to 500
Definition at line 179 of file req_errors.h.
| #define REQ_get_primary_secondary_failed (EMH_REQ_error_base + 452) |
Definition at line 180 of file req_errors.h.
| #define REQ_getTransientFileTickets_failed (EMH_REQ_error_base + 415) |
Definition at line 167 of file req_errors.h.
| #define REQ_import_new_specification_in_folder (EMH_REQ_error_base + 454) |
An error has occurred while pasting the Specification "%1$" to the folder "%2$". The Specification has been pasted to the Newstuff folder instead.
Definition at line 184 of file req_errors.h.
| #define REQ_import_wordlive_partial_sucess (EMH_REQ_error_base + 73) |
Definition at line 79 of file req_errors.h.
| #define REQ_invalid_column_data (EMH_REQ_error_base + 47) |
Definition at line 62 of file req_errors.h.
| #define REQ_invalid_column_order (EMH_REQ_error_base + 34) |
Definition at line 49 of file req_errors.h.
| #define REQ_invalid_excel_template_path (EMH_REQ_error_base + 31) |
Definition at line 46 of file req_errors.h.
| #define REQ_invalid_html_object_template_path (EMH_REQ_error_base + 506) |
The following path used to import an HTML object template is invalid: %1$.
Definition at line 197 of file req_errors.h.
| #define REQ_invalid_link_type (EMH_REQ_error_base + 453) |
The Link type specified in the configuration file is invalid.
Definition at line 182 of file req_errors.h.
| #define REQ_invalid_markup_comment_XML (EMH_REQ_error_base + 416) |
Definition at line 168 of file req_errors.h.
| #define REQ_invalid_object_type (EMH_REQ_error_base + 303) |
The input object type "%1$" is invalid for this operation. Please select an Item Revision.
Definition at line 145 of file req_errors.h.
| #define REQ_invalid_object_uid (EMH_REQ_error_base + 85) |
Definition at line 91 of file req_errors.h.
| #define REQ_invalid_relation_columns_pos (EMH_REQ_error_base + 44) |
Definition at line 59 of file req_errors.h.
| #define REQ_invalid_report_uid (EMH_REQ_error_base + 86) |
Definition at line 92 of file req_errors.h.
| #define REQ_invalid_resolution_object (EMH_REQ_error_base + 505) |
An invalid object is passed for the Trace Link creation. A valid POM Object is expected.
Definition at line 195 of file req_errors.h.
| #define REQ_invalid_revrule_uid (EMH_REQ_error_base + 87) |
Definition at line 93 of file req_errors.h.
| #define REQ_invalid_tag_nulltag (EMH_REQ_error_base + 408) |
Definition at line 160 of file req_errors.h.
| #define REQ_invalid_temp_directory (EMH_REQ_error_base + 407) |
Definition at line 159 of file req_errors.h.
| #define REQ_invalid_template_type (EMH_REQ_error_base + 84) |
Definition at line 90 of file req_errors.h.
| #define REQ_invalid_traceview_template (EMH_REQ_error_base + 209) |
The Trace View template "%1$" is invalid. The number of reports in Trace View should match the number of sheets in the template.
Please select an appropriate template as per the report type of Trace View.
Definition at line 137 of file req_errors.h.
| #define REQ_markup_file_empty_or_parse_failed (EMH_REQ_error_base + 417) |
Definition at line 169 of file req_errors.h.
| #define REQ_markup_present (EMH_REQ_error_base + 424) |
Definition at line 176 of file req_errors.h.
| #define REQ_memory_allocation_failed (EMH_REQ_error_base + 401) |
Definition at line 153 of file req_errors.h.
| #define REQ_missing_columns (EMH_REQ_error_base + 35) |
Definition at line 50 of file req_errors.h.
| #define REQ_module_initialization_failed (EMH_REQ_error_base + 1) |
Module level errors - ALLOCATING 20 positions
Definition at line 29 of file req_errors.h.
| #define REQ_multiple_flat_file_datasets (EMH_REQ_error_base + 504) |
The operation has failed, because multiple flat file datasets are attached to the specification revision "%1$".
Definition at line 193 of file req_errors.h.
| #define REQ_multiple_object_not_allowed (EMH_REQ_error_base + 300) |
Word Offline Import Error messages Range 300 to 400
Definition at line 140 of file req_errors.h.
| #define REQ_no_attributes_for_export (EMH_REQ_error_base + 40) |
Definition at line 55 of file req_errors.h.
| #define REQ_no_datasets_found (EMH_REQ_error_base + 420) |
Definition at line 172 of file req_errors.h.
| #define REQ_no_fulltext_dataset_found (EMH_REQ_error_base + 419) |
Definition at line 171 of file req_errors.h.
| #define REQ_no_input_objects (EMH_REQ_error_base + 302) |
No input object is being provided. Please select the object to find the matching BOM Line.
Definition at line 143 of file req_errors.h.
| #define REQ_no_matching_rule (EMH_REQ_error_base + 36) |
Definition at line 51 of file req_errors.h.
| #define REQ_no_named_reference (EMH_REQ_error_base + 41) |
Definition at line 56 of file req_errors.h.
| #define REQ_non_workspace_objects (EMH_REQ_error_base + 76) |
Definition at line 82 of file req_errors.h.
| #define REQ_not_supported_for_reimport (EMH_REQ_error_base + 203) |
Definition at line 129 of file req_errors.h.
| #define REQ_not_well_formed_body_text (EMH_REQ_error_base + 80) |
Definition at line 86 of file req_errors.h.
| #define REQ_objects_not_found (EMH_REQ_error_base + 83) |
Definition at line 89 of file req_errors.h.
| #define REQ_open_revision_exists (EMH_REQ_error_base + 501) |
Flat File error messages Range 501 to 550 The object "%1$" cannot be revised, because a working revision already exists and the system does not support more than one working revision.
Definition at line 187 of file req_errors.h.
| #define REQ_relation_type_not_found (EMH_REQ_error_base + 406) |
Definition at line 158 of file req_errors.h.
| #define REQ_revision_already_associated (EMH_REQ_error_base + 78) |
Definition at line 84 of file req_errors.h.
| #define REQ_runtimeobjects_not_supported (EMH_REQ_error_base + 204) |
Definition at line 130 of file req_errors.h.
| #define REQ_string_exceeds_maxlength (EMH_REQ_error_base + 59) |
Definition at line 73 of file req_errors.h.
| #define REQ_styles_template_not_found (EMH_REQ_error_base + 27) |
Definition at line 42 of file req_errors.h.
| #define REQ_summ_report_genurl_failed (EMH_REQ_error_base + 208) |
Definition at line 134 of file req_errors.h.
| #define REQ_template_not_found (EMH_REQ_error_base + 82) |
Definition at line 88 of file req_errors.h.
| #define REQ_tracelink_to_self (EMH_REQ_error_base + 503) |
The Trace Link cannot be created, because the source and the target objects are the same (%1$).
Definition at line 191 of file req_errors.h.
| #define REQ_TRANSCODING_ERROR (EMH_REQ_error_base + 77) |
Definition at line 83 of file req_errors.h.
| #define REQ_transfer_mode_rule_found (EMH_REQ_error_base + 301) |
Definition at line 141 of file req_errors.h.
| #define REQ_unable_to_download_file (EMH_REQ_error_base + 423) |
Definition at line 175 of file req_errors.h.
| #define REQ_unknown_error (EMH_REQ_error_base + 400) |
Markup and general REQ error messages Range 400 to 450
Definition at line 152 of file req_errors.h.
| #define REQ_update_markups_failed (EMH_REQ_error_base + 422) |
Definition at line 174 of file req_errors.h.
| #define REQ_url_application_name "WEB_default_site_deployed_app_name" |
Defines the name of the preference used to store the teamcenter application name for 4-tier.
Definition at line 75 of file requirement.h.
| #define REQ_url_protocol_preference "WEB_protocol" |
Defines the name of the preference used to store the protocol used (HTTP/HTTPS) to connect to the 4-tier server url.
Definition at line 73 of file requirement.h.
| #define REQ_url_server_preference "WEB_default_site_server" |
Defines the name of the preference used to store the url used to connect to 4-tier server.
Definition at line 71 of file requirement.h.
| #define REQ_Word_template_not_found (EMH_REQ_error_base + 205) |
Definition at line 131 of file req_errors.h.
| #define REQ_xml_exception (EMH_REQ_error_base + 418) |
Definition at line 170 of file req_errors.h.
| #define TEMPLATE_contains_custom_parts (EMH_REQ_error_base + 110) |
The presence of custom document properties is detected in the imported Word document, which is not supported. In the
Word application, use the following menu command sequence to remove them: File->Info->Properties->Advanced Properties.
Definition at line 120 of file req_errors.h.
| #define TEMPLATE_duplicate_name (EMH_REQ_error_base + 71) |
Definition at line 76 of file req_errors.h.
| #define TEMPLATE_empty_name (EMH_REQ_error_base + 72) |
Definition at line 77 of file req_errors.h.
| #define TEMPLATE_failed_to_add_parts (EMH_REQ_error_base + 75) |
Definition at line 81 of file req_errors.h.
| #define TEMPLATE_insufficient_privillage (EMH_REQ_error_base + 70) |
Definition at line 75 of file req_errors.h.
| #define TEMPLATE_insufficient_privillage_for_editing (EMH_REQ_error_base + 74) |
Definition at line 80 of file req_errors.h.
| typedef enum REQ_content_types_e REQ_content_types_t |
Defines the valid content types of the FullText object.
| enum REQ_content_types_e |
Defines the valid content types of the FullText object.
Definition at line 90 of file requirement.h.
| REQ_API int REQ_collect_markups | ( | int | req_rev_count, |
| const tag_t * | req_rev_list, | ||
| char ** | markup_file_path | ||
| ) |
Retrieves a consolidated Markup file given a list of Requirement IDs.
For multiple requirements, different markup files are combined into one file and its path is returned.
| req_rev_count | (I) Number of requirements |
| req_rev_list | (I) Requirement IDs |
| markup_file_path | (OF) The consolidated markup file location |
| REQ_API int REQ_excel_export | ( | int | object_count, |
| const tag_t * | objects, | ||
| int | attribute_count, | ||
| const char ** | attributes, | ||
| const char * | template_name, | ||
| const char * | application_format, | ||
| int | export_option_count, | ||
| const REQ_importexport_options_t * | export_options, | ||
| char ** | file_path | ||
| ) |
Exports the Teamcenter objects to Excel file.
The exported sheet can also be used for bulk update or reimport depending upon the applicationFormat.
| object_count | (I) objects count selected for export |
| objects | (I) objects selected for export |
| attribute_count | (I) Attribute count |
| attributes | (I) Attributes |
| template_name | (I) Name of Template to be exported |
| application_format | (I) Application format. Supported application format for this operation are:
|
| export_option_count | (I) Number of export options |
| export_options | (I) Array of export options |
| file_path | (OF) Generated Excel file path |
| REQ_API int REQ_set_contents | ( | tag_t | rev_or_fulltext_tag, |
| REQ_content_types_t | content_type, | ||
| const char * | contents | ||
| ) |
Sets the content on the Fulltext object attached to revision object.
Accepts both revision and Fulltext tag as input. In case revision is input, it will traverse to Fulltext object attached to it.
| rev_or_fulltext_tag | (I) Tag of revision or fulltext object. If revision is specified, it will traverse to its fulltext object. |
| content_type | (I) Type of content to set on the fulltext, i.e. Plain/HTML/Rich Text(MS Word compatible) |
| contents | (I) The actual content to set on fulltext object |
| REQ_API int REQ_word_export | ( | int | size, |
| const tag_t * | bom_lines, | ||
| logical | deep, | ||
| int | document_type, | ||
| const char * | specification_template, | ||
| int | object_template_count, | ||
| const char ** | bo_type, | ||
| const char ** | object_template, | ||
| int | export_option_count, | ||
| const REQ_importexport_options_t * | export_options, | ||
| const char * | mode_of_operation, | ||
| char ** | document_location | ||
| ) |
Exports the Teamcenter objects to Word document.
The exported document can be used for structure editing and work offline or for editing properties of objects.
| size | (I) Number of tags |
| bom_lines | (I) Tags of BOMLines to export |
| deep | (I) Logical falg to decide whethere to traverse the tree or not |
| document_type | (I) Type of document( 0 for static and 1 for live ) |
| object_template_count | (I) Specification Template override |
| bo_type | (I) Count of objecttemplate override |
| object_template | (I) Types of Business Object Overrides |
| export_option_count | (I) Object templates for BO type (I) Number of export options |
| export_options | (I) Array of export options |
| mode_of_operation | (I) Mode of operation while exporting( MSWordXML/MSWordXMLLive/MSWordXMLFN/MSWordXMLLiveFN/ /StructureWithContents/StructureOnly/MSWordXMLLiveMarkup/MSWordXMLLiveMarkupFN) |
| document_location | (OF) Location of document in file system |
| REQ_API int USER_create_tracelink | ( | const char * | tracelink_type, |
| const char * | tracelink_direction, | ||
| int | parent_object_count, | ||
| tag_t * | parent_objects, | ||
| int | child_object_count, | ||
| tag_t * | child_objects | ||
| ) |
Performs creation and update of generic relation between defining and complying objects.
It provides the ability to customize the creation and update using the user exits feature.
Custom user exits can be implemented against the string "USER_create_tracelink".
| tracelink_type | (I) Type of trace link |
| tracelink_direction | (I) Direction of trace link |
| parent_object_count | (I) Number of parent objects |
| parent_objects | (I) Array of parent objects |
| child_object_count | (I) Number of child objects |
| child_objects | (I) Array of child objects |
| C REQ_API int USER_search | ( | const char ** | property_names, |
| const char ** | property_values, | ||
| int | property_count, | ||
| int * | object_count, | ||
| tag_t ** | object_list | ||
| ) |
Performs a search in the database based on the provided property names and values.
It provides the ability to customize the search functionality through the user exits feature.
Custom user exits can be implemented using the string "USER_search".
| property_names | (I) Array of property names |
| property_values | (I) Array of property values |
| property_count | (I) Number of properties passed |
| object_count | (O) Number of objects found |
| object_list | (OF) object_count Array of found objects |