Modules
	Architecture

	RDV Errors

	RDV QPL API

	RDV Tokens

Macros
#define	EXE_EXT ".exe"

#define	PATH_SEP "/"

#define	PATHSTR "PATH"

#define	PATHTERM ":"

#define	TCROOT "TC_ROOT"

#define	TCTEMPDIR "TC_TMP_DIR"

Typedefs
typedef void *	RDV_context_t

typedef int(*	RDV_is_ia_function_t )(tag_t bom_line, logical *is_IA)

typedef int	RDV_object_type_token

typedef void *	RDV_search_engine_id_t

typedef void *	RDV_search_engine_t

Functions
RDV_API int	ARCH_update_option_declaration (tag_t option_rev)

RDV_API int	extract_psoccchain_from_bomlineprops (int position, char bomline_props, char OccChain)

RDV_API int	RDV_add_design_to_ia (tag_t component, tag_t iaRev, int prodRev_count, tag_t prodRev_tags, tag_t arch_element_apn, int a_count, tag_t a_nves, int b_count, tag_t b_nves, int n_requested_occurrences, int n_lous, tag_t lous, tag_t **apns_of_requested_occurrences)

RDV_API int	RDV_add_part_solution_to_product (tag_t component, tag_t genericObjectBOMLine, int prodRev_count, tag_t prodRev_tags, tag_t goApn_tag, int a_count, tag_t a_nves, int quantity, int n_note_text, char note_text, char note_types, tag_t *occurrence)

RDV_API int	RDV_add_part_to_product (tag_t component, tag_t genericObjectBOMLine, int prodRev_count, tag_t prodRev_tags, tag_t goApn_tag, int a_count, tag_t a_nves, int quantity, tag_t *occurrence)

RDV_API int	RDV_add_with_touchpoint (tag_t parentTag, tag_t componentTag, logical processParents, logical processChildren)

RDV_API int	RDV_appr_srch_crt_create (tag_t typeTag, int noOfSelectedApnsOrBOMLines, const tag_t selectedApnsOrBOMLines, int noOfUnSelectedApnsOrBOMLines, const tag_t unSelectedApnsOrBOMLines, tag_t *scAppearancesObjTag)

RDV_API int	RDV_appr_srch_crt_get_attrs (tag_t scAppearancesObjTag, int noOfSelectedBOMlines, tag_t selectedBOMLines, int noOfUnselectedBOMlines, tag_t **unselectedBOMLines)

RDV_API int	RDV_ask_composite_property (tag_t component, const char composite_property, char *value)

RDV_API int	RDV_ask_composite_property_objs (tag_t component, const char composite_property, int n_related_components, tag_t **related_components)

RDV_API int	RDV_ask_installation_assembly (tag_t bom_line, tag_t *ia_bom_line)

RDV_API int	RDV_ask_latest_option_rev (tag_t variant, tag_t *variantRev)

RDV_API int	RDV_ask_overlay_variant_rules (int n_bom_lines, tag_t bom_lines, int n_variant_rules, tag_t **variant_rules)

RDV_API int	RDV_ask_search_engine_bv_type (tag_t *bom_view_type)

RDV_API int	RDV_ask_variable_variant_options (int n_bom_lines, tag_t bom_lines, tag_t variant_rule, int n_variant_options, tag_t **variant_options)

RDV_API int	RDV_ask_variant_xo_table_data (int n_ves, const tag_t ves, int n_column_headers, tag_t column_header_exprs, char column_header_strs, int n_ves_2_save, tag_t *ves_2_save, int n_rows, int n_columns, int n_table_chars, char **table_chars)

RDV_API int	RDV_attr_srch_crt_create (tag_t typeTag, const char name, const char value, int op, tag_t *scAttrObjTag)

RDV_API int	RDV_attr_srch_crt_get_attrs (tag_t scAttrObjTag, char *name, int op, char **value)

RDV_API int	RDV_bomline_copy (tag_t parentLine, tag_t childLine, logical carrySubstitutes, logical asSubstitute, logical copyXform, char occType, tag_t newLine)

RDV_API int	RDV_bomline_replace_with_substitutes (tag_t bomLine, tag_t item, tag_t *itemRevision)

RDV_API int	RDV_bomline_substitute_with_alternates (tag_t bomLine, tag_t item, tag_t *itemRevision)

RDV_API int	RDV_boxzone_srch_crt_create (tag_t typeTag, int noOfCoordinates, const double coordinates, int op, tag_t scBoxZoneObjTag)

RDV_API int	RDV_boxzone_srch_crt_get_attrs (tag_t scBoxZoneObjTag, int noOfCoordinates, double coordinates, int comparator)

RDV_API int	RDV_check_user_privilege (tag_t obj_tag, tag_t user_tag)

RDV_API int	RDV_clearHashTable ()

RDV_API int	RDV_clone_part_solution_bomline_for_revise (tag_t bomLine, tag_t apn_tag, tag_t abe_apn, tag_t appgrp, tag_t *newLine)

RDV_API int	RDV_config_plmxml (tag_t dataset_tag, char item_id, char rev, char svr, char entity_handle, int nb_of_targets, char target_lines, logical voo_flag, char plmxml_config_file, char *file_location)

RDV_API int	RDV_config_plmxml_mfk (tag_t dataset_tag, tag_t product_revision_tag, char svr, char entity_handle, char target_lines, logical voo_flag, char plmxml_config_file, char *file_location)

RDV_API int	RDV_config_plmxml_with_import (tag_t dataset_tag, tag_t revid_tag, char directoryName, int svrCount, char *svr, char importUtility, char importUtilityParameter, char logFileImport)

RDV_API int	RDV_config_plmxml_with_svr (tag_t dataset_tag, tag_t toprev, char directoryName, int svrCount, char **svr)

RDV_API int	RDV_config_plmxml_with_svr_with_log (tag_t datasetTag, tag_t toprev, char directory, int svrCount, char *svr, char logFileImport)

RDV_API int	RDV_context_add_object (tag_t obj, int n_added_objects, tag_t *added_objects)

RDV_API int	RDV_context_ask_bom_window (tag_t *bom_window)

RDV_API int	RDV_context_ask_context (RDV_context_t *rdv_context_object)

RDV_API int	RDV_context_ask_objects (RDV_object_type_token type_token, int n_objects, tag_t *objects)

RDV_API int	RDV_context_ask_search_engine (RDV_search_engine_t *search_engine)

RDV_API int	RDV_context_clear ()

RDV_API int	RDV_context_default_prox_search (int n_target_bom_lines, tag_t target_bom_lines, int n_unconfigured_target_bom_lines, tag_t *unconfigured_target_bom_lines, int n_unconfigurable_target_bom_lines, tag_t *unconfigurable_target_bom_lines, int n_background_bom_lines, tag_t *background_bom_lines, int n_unconfigured_background_bom_lines, tag_t *unconfigured_background_bom_lines, int n_unconfigurable_background_bom_lines, tag_t **unconfigurable_background_bom_lines)

RDV_API int	RDV_context_is_proximity_searchable (logical *is_searchable)

RDV_API int	RDV_context_is_searchable (logical *is_searchable)

RDV_API int	RDV_context_remove_object (tag_t object)

RDV_API int	RDV_context_set_bom_window (tag_t bom_window)

RDV_API int	RDV_context_set_context (RDV_context_t rdv_context_object)

RDV_API int	RDV_context_set_objects (int n_objects, tag_t *objects)

RDV_API int	RDV_create_base_options (tag_t product, const char option_name, const char option_value, tag_t opt_tag, tag_t opt_rev)

RDV_API int	RDV_create_nve_from_formula (const char code, const char desc, const char productName, const char productNamespace, const char formula, int op, const char comment, tag_t *newNVETag)

RDV_API char *	RDV_escape_xml_tag_value (const char *value)

RDV_API int	RDV_execute_eng_change_query (char item_id, char item_revision_id, int n_instances, tag_t *instances)

RDV_API int	RDV_execute_processes_query (char object_name, int n_instances, tag_t **instances)

RDV_API int	RDV_execute_search (RDV_search_engine_id_t engine_id, tag_t search_criteria, int n_results, char **results)

RDV_API int	RDV_execute_workparts_query (char item_id, int n_instances, tag_t **instances)

RDV_API int	RDV_export_config_nx_assembly (int targetCount, tag_t targetList, int backgrndCount, tag_t backgrndList, logical checkoutTargets, char namingFormat, char zipfilename, char *logfilename)

RDV_API int	RDV_export_config_nx_structure (int targetCount, tag_t targetLines, int backgroundCount, tag_t backgroundLines, logical checkoutTargets, char namingFormat, char zipFileTicket, char *logFileTicket)

RDV_API int	RDV_find_imprecise_abe (char gcId, tag_t topArchTag, tag_t bomWindowTag, int noOfMeapns, tag_t meApns, char genCompId, char **compDesc)

RDV_API int	RDV_find_precise_abe (char gcId, tag_t topArchTag, tag_t bomWindowTag, int noOfMeapns, tag_t meApns, char genCompId, char **compDesc)

RDV_API int	RDV_find_search_engine (tag_t product_item_rev, tag_t revision_rule, tag_t variant_rule, tag_t bom_window, RDV_search_engine_t *search_engine)

RDV_API int	RDV_formattr_srch_crt_create (const char relationtype, int parentType, const char formType, const char logicalOpr, const char propertyName, const char mathOpr, const char propType, int sizeOfValues, const char *value, tag_t scFormAttrObjTag)

RDV_API int	RDV_formattr_srch_crt_get_attrs (tag_t scFormAttrObjTag, char *relationtype, int parentType, char formType, char logicalOpr, char propertyName, char mathOpr, char *propType, int sizeOfValues, char ***values)

RDV_API int	RDV_generate_PLMXML_file (int numberOfBOMLines, int numOfSelectedBL, tag_t bomLineTags, tag_t selectedBLTags, tag_t bomWindow, char **genFileName)

RDV_API int	RDV_generate_pruned_plmxml (tag_t datasetTag, tag_t prodRevTag, tag_t window, tag_t svrTag, char entityHandles, int noOfTargetLines, tag_t targetLines, logical vooFlag, char **pruneFilePath)

RDV_API void	RDV_generate_tempfilename (char prefix, char *fileName)

RDV_API int	RDV_generate_variant_map (tag_t datasetTag, char revisionRule, char productId)

RDV_API int	RDV_get_apn_for_top_arch_and_bomwindow (char gcId, tag_t topArchTag, tag_t bomWindowTag, int noOfMeapns, tag_t meApns, char genCompId, char **compDesc)

RDV_API int	RDV_get_arch_bomline_comps (tag_t topLevelItem, tag_t meApn, tag_t bomWindowTag, int noOfChildComponents, tag_t childMeapns, tag_t *bomLines)

RDV_API int	RDV_get_arch_meapnchild_components (tag_t topLevelItem, tag_t meApn, tag_t bomWindowTag, int noOfChildComponents, char componentsGcid, char componentsName, tag_t *childMeapns)

RDV_API int	RDV_get_bomline_prop_chain (tag_t bomLine, char bomLineProp, logical is_string_prop, logical is_reference_prop, int noOfProps, char **props, int noOfBomLines, tag_t **bomLines)

RDV_API int	RDV_get_checkfilename_for_web (char **checkfilename)

RDV_API int	RDV_get_imprecise_abe_child_apns (tag_t topLevelItem, tag_t meApn, tag_t bomWindowTag, int noOfChildComponents, char componentsGcid, char componentsName, tag_t *childMeapns)

RDV_API int	RDV_get_Occurences_id (tag_t datasetTag, char entity_handle, char *retChar)

RDV_API int	RDV_get_precise_abe_child_apns (tag_t topLevelItem, tag_t meApn, tag_t bomWindowTag, int noOfChildComponents, char componentsGcid, char componentsName, tag_t *childMeapns)

RDV_API int	RDV_get_rev_rule (char fileBuff, char *revRulename)

RDV_API int	RDV_get_site_pref_values (const char pref_name, int num_pref_values, char ***pref_values)

RDV_API int	RDV_get_unconf_bom_lines_indexes (int n_bom_lines, tag_t bom_lines, logical showsUnconfiguredByDate, logical showsUnconfiguredVariants, int n_indexes, int **indexes)

RDV_API int	RDV_get_valid_overlay_bom_lines (const logical show_unconfigured_variant, const logical show_unconfigured_by_date, const int n_variant_rules, const tag_t variant_rules, int n_backgrnd_bomlines, tag_t backgrnd_bomlines, int n_unconfigured_bom_lines, tag_t **unconfigured_bom_lines)

RDV_API int	RDV_getbomlinesfromAbsoluteOccUIDs (char absolute_occurrence_uids, int num_of_absolute_occurrence_uids, tag_t bomWindow, tag_t bomlines, int *bomlineCount)

RDV_API int	RDV_getbomlinesfromapprpathnodeUIDs (char appr_path_node_uid, int localapprUIDLength, tag_t bomWindow, tag_t bomlines, int *bomlineCount)

RDV_API int	RDV_getIssues (char resultsFile, char *issuesArray, int issuesArrayLen)

RDV_API int	RDV_getRevision_fromDataset (tag_t dataset_tag, char **revisionRule)

RDV_API int	RDV_getTempFileName (char prefix, char *tempFileName)

RDV_API int	RDV_grp_srch_crt_create (tag_t typeTag, int noOfSearchCriterias, const tag_t search_criterias, int op, tag_t scGrpObjTag)

RDV_API int	RDV_grp_srch_crt_get_attrs (tag_t scGrpObjTag, int op, int noOfSubCriteria, tag_t **subCriteria)

RDV_API int	RDV_inclass_srch_crt_create (tag_t typeTag, tag_t icsClass, int icsOptions, int noOfUncts, const int uncts, const char unctValues, tag_t scInClassObjTag)

RDV_API int	RDV_inclass_srch_crt_get_attrs (tag_t scInClassObjTag, tag_t icsClass, int icsOptions, int noOfUncts, int uncts, char **unctValues)

RDV_API int	RDV_init ()

RDV_API int	RDV_is_ia_by_bomline_prop (tag_t bom_line, logical *is_IA)

RDV_API int	RDV_is_ia_by_ir_type (tag_t bom_line, logical *is_IA)

RDV_API int	RDV_is_ia_by_preciseness (tag_t bom_line, logical *is_IA)

RDV_API int	RDV_is_ia_by_transform (tag_t bom_line, logical *is_IA)

RDV_API int	RDV_is_installation_assembly (tag_t bomLine, logical *is_ia)

RDV_API int	RDV_is_part_shared (tag_t apn_tag, logical is_shared, int no_of_refs)

RDV_API int	RDV_is_product_item (tag_t item, logical *is_product_item)

RDV_API int	RDV_map_search_results_to_bom (tag_t bom_window, int n_stringsToMatch, const char *stringsToMatch, int n_bomlines, tag_t *bom_lines, int n_unconfigured_matches, tag_t *unconfigured_matches, int n_unconfigurable_bom_lines, tag_t **unconfigurable_bom_lines)

RDV_API int	RDV_mapattr_srch_crt_create (tag_t typeTag, const char name, const char value, int op, tag_t *scMappAttrObjTag)

RDV_API int	RDV_mapattr_srch_crt_get_attrs (tag_t scMapAttrObjTag, char *name, int op, char **value)

RDV_API int	RDV_named_variant_expr_create (const char code, const char desc, tag_t var1, tag_t var2, int op, const char comment, tag_t newNVETag)

RDV_API int	RDV_named_variant_expr_get_attrs (tag_t nveObjTag, char code, char desc, int fp, tag_t var1, tag_t var2, int op, char *comment, int no_of_literals, tag_t **literals)

RDV_API int	RDV_namedzone_srch_crt_create (tag_t typeTag, const char name, int op, tag_t scNamedZoneObjTag)

RDV_API int	RDV_namedzone_srch_crt_get_attrs (tag_t scNamedZoneObjTag, char *name, int comparator)

RDV_API int	RDV_parseFile (char inputFile, char input, char **inputValueArray, int length)

RDV_API int	RDV_parseFileHeader (char inputFile, char *sub_tokens, int length)

RDV_API int	RDV_planezone_srch_crt_create (tag_t typeTag, int noOfCoordinates, const double coordinates, int op, tag_t scPlaneZoneObjTag)

RDV_API int	RDV_planezone_srch_crt_get_attrs (tag_t scPlaneZoneObjTag, int noOfCoordinates, double coordinates, int comparator)

RDV_API int	RDV_prox_srch_crt_create (tag_t typeTag, double distance, tag_t targetAppearance, tag_t bgAppearance, tag_t *scProximityObjTag)

RDV_API int	RDV_prox_srch_crt_get_attrs (tag_t scProximityObjTag, double distance, tag_t targetAppearance, tag_t *bgAppearance)

RDV_API int	RDV_remove_designs_from_ia (tag_t productItem, int n_comps_to_be_cut, tag_t *comps_to_be_cut)

RDV_API int	RDV_remove_parts_related_to_abe (tag_t apn_tag, tag_t topline)

RDV_API int	RDV_replace_design_in_product (tag_t component, logical isUpdate, int bomLine_count, tag_t bomLine_tags, int prodRev_count, tag_t prodRev_tags, tag_t archApn_tag, int a_count, tag_t a_nves, int b_count, tag_t b_nves, int n_lou, tag_t *lous)

RDV_API int	RDV_replace_ind_design_in_product (tag_t component, tag_t bomLine, int prodRev_count, tag_t prodRev_tags, tag_t arch_element_apn, int a_count, tag_t a_nves, int b_count, tag_t b_nves, int n_lous, tag_t lous)

RDV_API int	RDV_replace_part_in_product (tag_t component, tag_t bomLine, tag_t archApn_tag, int a_count, tag_t *a_nves, logical splitAndClone, logical carrySubstitutes)

RDV_API int	RDV_replace_part_solution_in_product (tag_t component, tag_t bomLine, tag_t abeAPN, int n_authNVEs, tag_t authNVEs, logical splitAndClone, logical carrySubstitutes, int quantity, int n_noteTexts, char noteTypes, char *noteTexts)

RDV_API int	RDV_retrieve_trushape_operator_for_app_search (char *op)

RDV_API int	RDV_savedqry_srch_crt_create (tag_t typeTag, const char queryName, int noOfInstances, const char entries, const char values, tag_t scSQObjTag)

RDV_API int	RDV_savedqry_srch_crt_get_attrs (tag_t scSQObjTag, char *sqName, int noOfEntries, char *entries, char *values)

RDV_API int	RDV_search_engine_ask_id (RDV_search_engine_t search_engine, RDV_search_engine_id_t *id)

RDV_API int	RDV_set_ia_method (RDV_is_ia_function_t method_name)

RDV_API int	RDV_set_option_values (char item_info, char option_name, char option_value, tag_t var_exp_block)

RDV_API int	RDV_srch_crt_get_type (tag_t scObjTag, char **type)

RDV_API void	RDV_string_tokenizer (char string, char delimit, int count, char ***t)

RDV_API int	RDV_structurecontext_evaluate (tag_t scoTag, int mode, tag_t bom_window, int n_target_bom_lines, tag_t target_bom_lines, int n_unconfigured_target_bomlines, tag_t *unconfigured_target_bomlines, int n_unconfigurable_target_bom_lines, tag_t *unconfigurable_target_bom_lines, int n_bg_bom_lines, tag_t *bg_bom_lines, int n_unconfigured_bg_bomlines, tag_t *unconfigured_bg_bomlines, int n_unconfigurable_bg_bom_lines, tag_t **unconfigurable_bg_bom_lines)

RDV_API int	RDV_update_occurrences_with_vc_in_product (int bomLine_count, tag_t bomLines, int prodRev_count, tag_t prodRev_tags, tag_t arch_element_apn, int a_count, tag_t a_nves, int b_count, tag_t b_nves, int n_lous, tag_t *lous)

RDV_API int	RDV_variant_expression_as_text (tag_t ve, char **as_text)

RDV_API int	RDV_vis_strct_cntxt_obj_remove_sco_contents (tag_t structureContextObjectTag)

RDV_API int	RDV_vissco_ask_contents (tag_t visSCOTag, const char relationName, int subType, int numOFObjects, tag_t **objects)

RDV_API int	RDV_vissco_remove_content (tag_t visSCOTag, tag_t comp)

RDV_API int	WEB_RDV_create_scg (tag_t product_rev_tag, tag_t revision_rule, int no_variant_opts, tag_t variant_option_tags, int variant_option_values, tag_t saved_variant_rule_tag, int no_workparts, tag_t workpart_tags, int no_entries, const char entries, const char values, tag_t saved_qry_tag, double distance, int sel_tgt_occ_chain_size, const char sel_tgt_occ_thread_chain, int unsel_tgt_occ_chain_size, const char unsel_tgt_occ_thread_chain, int sel_bk_occ_chain_size, const char sel_bk_occ_thread_chain, int unsel_bk_occ_chain_size, const char unsel_bk_occ_thread_chain, logical voo_enabled, logical true_shape_enabled, int no_note_type, char note_type_str, char occ_qry_opr, char occ_values, int no_form_attr, char is_item_form_flag, char relation_type_names, char form_type_names, char form_logical_opr, char form_attr_name, char form_qry_opr, char form_string_val, int box_zone_instances, tag_t box_zone_tags, char *boxzone_comp, tag_t sc_filter_grp_tag)

RDV_API int	WEB_RDV_create_sco (char sco_type, char sco_name, char sco_desc, tag_t product_rev_tag, tag_t revision_rule, int no_variant_opts, tag_t variant_option_tags, int variant_option_values, tag_t saved_variant_rule_tag, int no_workparts, tag_t workpart_tags, tag_t tgt_saved_qry_tag, int no_tgt_crt, const char tgt_entires_crt, const char tgt_values_crt, int sel_tgt_occ_chain_size, const char sel_tgt_occ_thread_chain, int unsel_tgt_occ_chain_size, const char unsel_tgt_occ_thread_chain, int sel_bk_occ_chain_size, const char sel_bk_occ_thread_chain, int unsel_bk_occ_chain_size, const char unsel_bk_occ_thread_chain, int tgt_occ_chain_size, const char tgt_occ_thread_chain, int bk_occ_chain_size, const char bk_occ_thread_chain, int no_sc_filter_grp_tags, tag_t sc_filter_grp_tags, tag_t sco_tag)

RDV_API int	WEB_RDV_create_VISSC (tag_t item_rev_tag, tag_t revision_rule, int no_variant_opts, tag_t variant_option_tags, int variant_option_values, tag_t saved_variant_rule_tag, int occurrence_count, const char *occurrence_string_array, char client_id, tag_t *vscobj)

RDV_API int	WEB_RDV_decodeGetQPLScheme (char QPLItemID, int errorCodeStatus, int nMessages, char messageString, int nProximityInfo, char *proximityInfoString, int nAttributes, char *attributesString, int nZones, char **zonesString)

RDV_API int	WEB_RDV_execute_cacheless_search (tag_t product_tag, tag_t revision_rule, int no_variant_opts, tag_t variant_option_tags, int variant_option_values, tag_t saved_variant_rule_tag, int no_entries, char entries, char values, tag_t saved_qry_tag, int occ_types_size, char ignore_occ_types, double distance, int occ_chain_size, const char occ_thread_chain, logical voo_enabled, logical true_shape_enabled, int no_note_type, char note_type_str, char occ_qry_opr, char occ_values, int no_form_attr, char is_item_form_flag, char relation_type_names, char form_type_names, char form_attr_name, char form_qry_opr, char form_bool_val, char form_int_val, char form_double_val, char form_string_val, char form_date_val, char form_uid_val, int no_class_attr, char *class_names, int class_attr_ids, char *class_attr_values, logical larger_than, double diagonal_length, int box_zone_instances, tag_t box_zone_tags, char *boxzone_comp, int target_size, char *bom_line_prop, char ia_assembly, int unconfig_bom_line_size, char *unconfig_bom_line_prop, char *unconfig_ia_assembly)

RDV_API int	WEB_RDV_executeQPLFilter (char qplBuildID, char distance, char booleanOperator, int attCount, char attNames, char attOps, char attValues, int zoneAttrCount, char zoneAttrNames, char zoneAttrOps, int occCount, char occTags, int occEntityHandleCount, char **occEntityHandle)

RDV_API int	Web_rdv_get_rev_rule (char fileBuff, char *revRulename)

RDV_API int	WEB_RDV_get_sco_info (tag_t sco_tag, int sco_evaluate_mode, tag_t sco_rev_rule, tag_t sco_variant_rule, tag_t sco_prod_rev, int work_parts_size, char **work_parts_uids, double sco_prox_dist, int sco_zones_size, char sco_zones_comp, char sco_zones_uids, int svd_qry_entries_size, char *qry_entries, char qry_values, tag_t sco_svd_qry_tag, int occ_attr_size, char sco_occ_attr_name, char sco_occ_oper, char *sco_occ_attr_value, int no_form_attr, char *sco_is_item_form_flag, char sco_relation_type_names, char sco_form_logical_opr, char sco_form_type_names, char sco_form_attr_name, char sco_form_qry_opr, char *sco_form_string_val, logical sco_true_shape_enabled, logical sco_voo_enabled, logical sco_append_parts, int sco_target_lines_size, char sco_target_lines_occ_chain, char target_lines_ia, int sco_selected_target_lines_size, char **sco_selected_target_lines_props, int sco_backgrnd_lines_size, char *sco_backgrnd_lines_occ_chain, char backgrnd_lines_ia, int sco_selected_backgrnd_lines_size, char ***sco_selected_backgrnd_lines_props)

RDV_API int	WEB_RDV_getExecuteQPLFilterCount (char qplBuildID, char distance, char booleanOperator, int attCount, char attNames, char attOps, char attValues, int zoneAttrCount, char zoneAttrNames, char zoneAttrOps, int occCount, char occTags, int occEntityHandleCount, char **occEntityHandle)

RDV_API int	WEB_RDV_getQPLBuilds (char QPLBuildsBuffer, char productIds)

Detailed Description

This module provides an interface to common RDV functions, such as creating and manipulating RDV contexts, searching for instances within an RDV context, and interpreting search results. These functions correspond to the functionality provided in the DesignContext application in Teamcenter Engineering and the View In Context functionality in Web Access.

The prototypes for these functions are in rdv.h.

RDV API return codes are defined in rdv_errors.h.

The RDV module maintains a state that defines the currently active RDV context. Applications may use the RDV API to control the RDV context being active by obtaining and setting contexts as appropriate.

Many RDV functions are sensitive to Teamcenter Engineering preferences defined in $TC_DATA/.iman_env or the corresponding user, group, or role preferences. Please refer to the documentation provided in $TC_DATA/.iman_env for more detail. Preference values are automatically read upon calling the first RDV API call. If the preferences are changed during the Teamcenter Engineering session, the application may enforce a re-evaluation.

Common Return Values

BOM_invalid_tag	Input BOM window is a NULLTAG
ITK_internal_error	Error in the Search Engine API layer. Additional information may be found in the syslog file.
ITK_no_acs_license	No RDV license available.
RDV_cannot_add_null_tag	Cannot add NULLTAGs to RDV contexts.
RDV_cannot_find_object	Can't find object.
RDV_cannot_initialize_search_criteria	Can't instantiate Class.
RDV_cannot_retrieve_attr	Can't retrieve attribute from object.
RDV_context_not_searchable	An RDV search was requested in a non-searchable context.
RDV_illegal_parameter	Conflicting input parameters: bom_window and product_item_rev The Product ItemRevision does not match the BOM window top line bom_window and revision_rule The RevisionRule does not match the BOM window's revision rule bom_window and variant_rule The VariantRule does not match the BOM window's variant rule
RDV_invalid_composite_prop_name	The evaluation of a Composite Property failed that is defined in one of the following preferences: PortalDesignContextECObject.WorkPartProperties defining properties to add WorkParts affected by a change object PortalDesignContextProcess.WorkPartProperties<BR> defining properties to add WorkParts affected by a process object Either a syntax error was detected or a regular property name was invalid. Additional information may be found in the syslog file.
RDV_invalid_composite_prop_type	The evaluation of a Composite Property failed that is defined in one of the following preferences: PortalDesignContextECObject.WorkPartProperties<BR> defining properties to add WorkParts affected by a change object PortalDesignContextProcess.WorkPartProperties defining properties to add WorkParts affected by a process object The Composite Property contains regular property, which is neither an [un]typed_relation nor an [un]typed_reference. Additional information may be found in the syslog file.
RDV_invalid_context	An invalid RDV context was specified. The context was not obtained by calling RDV_context_ask_context().
RDV_invalid_installation	RDV is either not installed or the installation is invalid or incomplete
RDV_maximum_exceeded	The maximum number of objects to add was exceeded. The maximum is set with the PortalDesignContextMaxMatchingObjects preference.
RDV_object_not_found	The object was not fond in the current RDV context

Macro Definition Documentation

#define EXE_EXT ".exe"

Definition at line 109 of file rdv.h.

#define PATH_SEP "/"

Definition at line 115 of file rdv.h.

#define PATHSTR "PATH"

Definition at line 108 of file rdv.h.

#define PATHTERM ":"

Definition at line 116 of file rdv.h.

#define TCROOT "TC_ROOT"

Definition at line 106 of file rdv.h.

#define TCTEMPDIR "TC_TMP_DIR"

Definition at line 105 of file rdv.h.

Typedef Documentation

typedef void* RDV_context_t

Definition at line 128 of file rdv.h.

typedef int(* RDV_is_ia_function_t)(tag_t bom_line, logical *is_IA)

Definition at line 119 of file rdv.h.

typedef int RDV_object_type_token

Definition at line 130 of file rdv.h.

typedef void* RDV_search_engine_id_t

Definition at line 126 of file rdv.h.

typedef void* RDV_search_engine_t

Definition at line 124 of file rdv.h.

Function Documentation

RDV_API int ARCH_update_option_declaration ( tag_t option_rev )

Parameters

option_rev (I)

RDV_API int extract_psoccchain_from_bomlineprops	(	int	position,
		char **	bomline_props,
		char **	OccChain
	)

RDV_API int RDV_add_design_to_ia	(	tag_t	component,
		tag_t	iaRev,
		int	prodRev_count,
		tag_t *	prodRev_tags,
		tag_t	arch_element_apn,
		int	a_count,
		tag_t *	a_nves,
		int	b_count,
		tag_t *	b_nves,
		int	n_requested_occurrences,
		int	n_lous,
		tag_t *	lous,
		tag_t **	apns_of_requested_occurrences
	)

Parameters

component	(I)
iaRev	(I)
prodRev_count	(I)
prodRev_tags	(I)
arch_element_apn	(I)
a_count	(I)
a_nves	(I)
b_count	(I)
b_nves	(I)
n_requested_occurrences	(I)
n_lous	(I)
lous	(I)
apns_of_requested_occurrences	(OF)

RDV_API int RDV_add_part_solution_to_product	(	tag_t	component,
		tag_t	genericObjectBOMLine,
		int	prodRev_count,
		tag_t *	prodRev_tags,
		tag_t	goApn_tag,
		int	a_count,
		tag_t *	a_nves,
		int	quantity,
		int	n_note_text,
		char **	note_text,
		char **	note_types,
		tag_t *	occurrence
	)

This method adds a part along with the part data.

Parameters

component	(I)
genericObjectBOMLine	(I)
prodRev_count	(I)
prodRev_tags	(I) prodRev_count
goApn_tag	(I)
a_count	(I)
a_nves	(I) a_count
quantity	(I)
n_note_text	(I)
note_text	(I)
note_types	(I)
occurrence	(O)

RDV_API int RDV_add_part_to_product	(	tag_t	component,
		tag_t	genericObjectBOMLine,
		int	prodRev_count,
		tag_t *	prodRev_tags,
		tag_t	goApn_tag,
		int	a_count,
		tag_t *	a_nves,
		int	quantity,
		tag_t *	occurrence
	)

This method adds a part to a Generic Object Element's structure.

Parameters

component	(I)
genericObjectBOMLine	(I)
prodRev_count	(I)
prodRev_tags	(I) prodRev_count
goApn_tag	(I)
a_count	(I)
a_nves	(I) a_count
quantity	(I)
occurrence	(O)

RDV_API int RDV_add_with_touchpoint	(	tag_t	parentTag,
		tag_t	componentTag,
		logical	processParents,
		logical	processChildren
	)

Parameters

parentTag	(I)
componentTag	(I)
processParents	(I)
processChildren	(I)

RDV_API int RDV_appr_srch_crt_create	(	tag_t	typeTag,
		int	noOfSelectedApnsOrBOMLines,
		const tag_t *	selectedApnsOrBOMLines,
		int	noOfUnSelectedApnsOrBOMLines,
		const tag_t *	unSelectedApnsOrBOMLines,
		tag_t *	scAppearancesObjTag
	)

This function is used for creating a Search Criteria Appearance object. It takes tag arrays of selected and unselected appearances. It returns the tag of search criteria appearance object tag created.

Parameters

typeTag	(I) The object type tag for the search criteria object. The type tag can be obtained by calling TCTYPE_find_type(), e.g. TCTYPE_find_type( "ApprSearchCriteriaSlctState", "ApprSearchCriteriaSlctState", &my_type_tag )
noOfSelectedApnsOrBOMLines	(I) Number of selected appearances
selectedApnsOrBOMLines	(I) noOfSelectedBOMlines Selected appearances
noOfUnSelectedApnsOrBOMLines	(I) Number of unselected appearances
unSelectedApnsOrBOMLines	(I) noOfUnselectedBOMLines Unselected appearances
scAppearancesObjTag	(O) The resulting search criteria object. The object will not be persistently saved until you call AOM_save().

RDV_API int RDV_appr_srch_crt_get_attrs	(	tag_t	scAppearancesObjTag,
		int *	noOfSelectedBOMlines,
		tag_t **	selectedBOMLines,
		int *	noOfUnselectedBOMlines,
		tag_t **	unselectedBOMLines
	)

This function is used for retrieving the selected and unselected appearances at the time of saving this object. This is used by DesignContext Application to replay a filter.

Parameters

scAppearancesObjTag	(I) The search criteria object
noOfSelectedBOMlines	(O) Number of selected appearances
selectedBOMLines	(OF) noOfSelectedBOMlines Selected appearances
noOfUnselectedBOMlines	(O) Number of unselected appearances
unselectedBOMLines	(OF) noOfUnselectedBOMlines Unselected appearances

RDV_API int RDV_ask_composite_property	(	tag_t	component,
		const char *	composite_property,
		char **	value
	)

This call returns the Composite Property value for an Teamcenter Engineering component.

A Composite Property of an object defines a path to associated objects, with potentially multiple levels of indirection, resulting in an evaluation of a regular property on that or these associated object(s).

The syntax of a composite property is:

[objectTypeName.][referenceProperty[(criteriaProperty=criteriaValue[,criteriaProperty=criteriaValue]):][referenceProperty[(criteriaProperty=criteriaValue[,criteriaProperty=criteriaValue])]:]]property

where:

objectTypeName is a regular Teamcenter Engineering object type name (e.g. UGMASTER).
referenceProperty is either a typed_reference, untyped_reference, typed_relation, or an untyped_relation.
criteriaProperty can be any valid Composite Property (recursion). If specified it is taken as a criteria list in case the above referenceProperty is ambiguous.
property is any regular Teamcenter Engineering property name.
the notation "[" indicates optional elements, and is not part of Composite Property itself.

Examples:

object_type evaluates the regular property 'object_type'. This illustrates that each regular property is also a perfectly valid Composite Property.
item_master_tag:product_year evaluates the property 'product_year' on the ItemRevision Master of an Item Revision.
item_tag:item_master_tag:Project_ID evaluates the property Project_ID on the Item Master of the Item of an Item Revision.
item_tag:IMAN_master_form(object_type=MyCustomItemForm):MyCustomProperty evaluates the property MyCustomProperty of all objects in the IMAN_master_form pseudo folder of the Item of an Item Revision, that have the object type "MyCustomItemForm", returning all values in a comma separated list.
ItemRevision Master.revision_list:item_master_tag:Project_ID evaluates the property Project_ID on each Item Revision of a given Item. In case 3 Item Revision share the same Project ID 3200, these duplicated values are shown as '3200 (x3)'. A list of values is separated by a comma and a blank character. The prefix ItemRevision Master indicates that the ultimate physical property is actually on an object of type ItemRevision Master.

Restrictions:

Each intermediate step in the chain of properties references the next related object(s) in the path. Except for the last property, they must by specified by either a:

typed_reference
untyped_reference
typed_relation
untyped_relation

Deprecated:: This function is deprecated, it will be removed from Teamcenter 11. From Tc9.0 onwards, please use PROP_ask_composite_property.

Parameters

component	(I) Component for which the Composite Property is to be evaluated
composite_property	(I) Composite Property to evaluate
value	(OF) Returned property value

RDV_API int RDV_ask_composite_property_objs	(	tag_t	component,
		const char *	composite_property,
		int *	n_related_components,
		tag_t **	related_components
	)

This call returns an array of related Teamcenter Engineering components pointed to be a Composite Property value for a given Teamcenter Engineering component. See also RDV_ask_composite_property().

Restrictions:

Each intermediate step in the chain of properties references the next related object(s) in the path. Except for the last property, they must by specified by either a

typed_reference
untyped_reference
typed_relation
untyped_relation

Deprecated:: This function is deprecated, it will be removed from Teamcenter 11. From Tc9.0 onwards, please use PROP_ask_composite_property_objs.

Parameters

component	(I) Component for which the Composite Property is to be evaluated
composite_property	(I) Composite Property to evaluate
n_related_components	(O) The number of returned components in related_components
related_components	(OF) n_related_components The array of components pointed to by the Composite Property

RDV_API int RDV_ask_installation_assembly	(	tag_t	bom_line,
		tag_t *	ia_bom_line
	)

This call finds the parent Installation Assembly BOMLine among all parent BOMLines. The chain of BOMLines leading from the input BOMLine to the root of the tree is traversed according to the setting of the preference PortalDesignContextFindInstallationTreeWalkIncrement where -1 means down and 1 means up. For each BOMLinein this chain the currently active RDV_is_ia_function_t function is called. The function will return the 1st BOMLine for which the RDV_is_ia_function_t function returns TRUE. If no parent BOMLine matched the criteria, a NULLTAG is returned.

Parameters

bom_line	(I) The BOMLine to search the Installation Assembly for
ia_bom_line	(O) The Installation Assembly BOMLine for the input bom_line

RDV_API int RDV_ask_latest_option_rev	(	tag_t	variant,
		tag_t *	variantRev
	)

Deprecated:: This function is deprecated, it will be removed from Teamcenter 11. From Tc9.0 onwards, please use PS_ask_latest_option_rev.

RDV_API int RDV_ask_overlay_variant_rules	(	int	n_bom_lines,
		tag_t *	bom_lines,
		int *	n_variant_rules,
		tag_t **	variant_rules
	)

This call will return the list of variant rules covering all valid variant overlays. The list is a complete list of variant rules for which at least one input BOMLine configures. Calls to this function may take a considerable amount of time. The following preference may be used in order to limit the processing time:

PortalDesignContextSetVariantRulesMaxTargetAppearances
If the number of input bom lines given in n_bom_lines exceeds this limit, the array being returned will be NULL.
PortalDesignContextSetVariantRulesMaxVariantRules
If the number of variant options relevant to the input bom line array bom_lines exceeds this limit, the array being returned will be NULL.

Parameters

n_bom_lines	(I) The number of input bom lines for which the set of variant rules is to be returned
bom_lines	(I) n_bom_lines The input bom lines for which the set of variant rules is to be returned
n_variant_rules	(O) The number of output variant rules
variant_rules	(OF) n_variant_rules The output variant rules

RDV_API int RDV_ask_search_engine_bv_type ( tag_t * bom_view_type )

Parameters

bom_view_type (O)

RDV_API int RDV_ask_variable_variant_options	(	int	n_bom_lines,
		tag_t *	bom_lines,
		tag_t	variant_rule,
		int *	n_variant_options,
		tag_t **	variant_options
	)

This call will return the list of variant options that are variable for the provided list of BOM lines. The required variant rule tag may be obtained from BOM_window_ask_variant_rule(). All options in this rule that are not explicitly set by the user will be unset when the call returns. Use BOM_variant_rule_delete() to dispose of this variant rule once it will no longer be used.

Parameters

n_bom_lines	(I) The number of input bom lines for which the set of variable variant options is to be returned
bom_lines	(I) n_bom_lines The input bom lines for which the set of variable variant options is to be returned
variant_rule	(I) The variant rule to work with. This tag may be obtained from BOM_window_ask_variant_rule(). All options not explicitly set by the user in this variant rule will be unset when the call returns. Use BOM_variant_rule_delete() to dispose of this variant rule when it will not be used any longer.
n_variant_options	(O) The number of output variant options
variant_options	(OF) n_variant_options The output variant options

RDV_API int RDV_ask_variant_xo_table_data	(	int	n_ves,
		const tag_t *	ves,
		int *	n_column_headers,
		tag_t **	column_header_exprs,
		char ***	column_header_strs,
		int *	n_ves_2_save,
		tag_t **	ves_2_save,
		int *	n_rows,
		int *	n_columns,
		int *	n_table_chars,
		char **	table_chars
	)

Parameters

n_ves	(I)
ves	(I) n_ves
n_column_headers	(O)
column_header_exprs	(OF) n_column_headers
column_header_strs	(OF) n_column_headers as string
n_ves_2_save	(O)
ves_2_save	(OF) n_ves_2_save
n_rows	(O)
n_columns	(O)
n_table_chars	(O)
table_chars	(OF) n_table_chars

RDV_API int RDV_attr_srch_crt_create	(	tag_t	typeTag,
		const char *	name,
		const char *	value,
		int	op,
		tag_t *	scAttrObjTag
	)

This function is used for creating a Search Criteria Attribute object. It takes the object type, attribute name, value and the operator and returns the tag of the resulting Attribute Filter Search Criteria object.

Parameters

typeTag	(I) The object type tag for the search criteria object. The type tag can be obtained by calling TCTYPE_find_type(), e.g. TCTYPE_find_type( "ApprSearchCriteriaAttribute", "ApprSearchCriteriaAttribute", &my_type_tag )
name	(I) The name of the attribute to search by
value	(I) The required value
op	(I) The comparator. Can be a combination of one or more of: POM_not POM_is_equal_to POM_is_greater_than POM_is_less_than POM_is_null POM_is_like
scAttrObjTag	(O) The resulting search criteria object. The object will not be persistently saved until you call AOM_save().

RDV_API int RDV_attr_srch_crt_get_attrs	(	tag_t	scAttrObjTag,
		char **	name,
		int *	op,
		char **	value
	)

This function is used for retrieving the name, value and operator from a Search Criteria Attribute Filter object.

Parameters

scAttrObjTag	(I) The attribute search criteria object
name	(OF) The name of the attribute to search by
op	(O) The comparator. Can be a combination of one or more of: POM_not POM_is_equal_to POM_is_greater_than POM_is_less_than POM_is_null POM_is_like
value	(OF) The value this criterion requires

RDV_API int RDV_bomline_copy	(	tag_t	parentLine,
		tag_t	childLine,
		logical	carrySubstitutes,
		logical	asSubstitute,
		logical	copyXform,
		char *	occType,
		tag_t *	newLine
	)

Parameters

parentLine	(I)
childLine	(I)
carrySubstitutes	(I)
asSubstitute	(I)
copyXform	(I)
occType	(I)
newLine	(O)

RDV_API int RDV_bomline_replace_with_substitutes	(	tag_t *	bomLine,
		tag_t *	item,
		tag_t *	itemRevision
	)

Parameters

bomLine	(I/O)
item	(I)
itemRevision	(I)

RDV_API int RDV_bomline_substitute_with_alternates	(	tag_t *	bomLine,
		tag_t *	item,
		tag_t *	itemRevision
	)

Parameters

bomLine	(I/O)
item	(I)
itemRevision	(I)

RDV_API int RDV_boxzone_srch_crt_create	(	tag_t	typeTag,
		int	noOfCoordinates,
		const double *	coordinates,
		int	op,
		tag_t *	scBoxZoneObjTag
	)

This function is used for creating a Search Criteria Box Zone object. It takes the coordinates of the box and the operator value and returns the tag of the resulting Box Zone Search Criteria object.

Parameters

typeTag	(I) The object type tag for the search criteria object. The type tag can be obtained by calling TCTYPE_find_type(), e.g. TCTYPE_find_type( "ApprSearchCriteriaBoxZone", "ApprSearchCriteriaBoxZone", &my_type_tag )
noOfCoordinates	(I) Expected to be 12
coordinates	(I) noOfCoordinates (x,y,z) coordinates of a corner of the box and 3 vectors for the box edges. Each of the vectors is expected in the form of (x,y,z)
op	(I) The comparator. Can be either: RDV_within RDV_outside RDV_interferes
scBoxZoneObjTag	(O) The resulting search criteria object. The object will not be persistently saved until you call AOM_save().

RDV_API int RDV_boxzone_srch_crt_get_attrs	(	tag_t	scBoxZoneObjTag,
		int *	noOfCoordinates,
		double **	coordinates,
		int *	comparator
	)

This function is used for retrieving the coordinates and operator from a Search Criteria Box Zone object.

Parameters

scBoxZoneObjTag	(I) The search criteria object
noOfCoordinates	(O) Expected to be 12
coordinates	(OF) noOfCoordinates (x,y,z) coordinates of a corner of the box and 3 vectors for the box edges. Each of the vectors is expected in the form of (x,y,z)
comparator	(O) The comparator. Can be either: RDV_within RDV_outside RDV_interferes

RDV_API int RDV_check_user_privilege	(	tag_t	obj_tag,
		tag_t	user_tag
	)

RDV_API int RDV_clearHashTable ( )

RDV_API int RDV_clone_part_solution_bomline_for_revise	(	tag_t	bomLine,
		tag_t	apn_tag,
		tag_t	abe_apn,
		tag_t	appgrp,
		tag_t *	newLine
	)

Parameters

bomLine	(I) > *
apn_tag	(I) > *
abe_apn	(I) > *
appgrp	(O) > *
newLine	(O) > *

RDV_API int RDV_config_plmxml	(	tag_t	dataset_tag,
		char *	item_id,
		char *	rev,
		char *	svr,
		char *	entity_handle,
		int	nb_of_targets,
		char *	target_lines,
		logical	voo_flag,
		char **	plmxml_config_file,
		char **	file_location
	)

This method generates a configured plmxml file from the unconfigured plmxml file, applying the saved variant rule. This function is called from Adhoc DC thin client. This ITK should not be used in MFK supported environment as it might return error, ITEM_multiple_items_returned, if multiple items are found with same ID.

The function returns:

ITK_ok on success
ITEM_item_not_found, if an invalid Item ID string is passed.
ITEM_multiple_items_returned, if multiple items are found with same ID in MFK environment.
RDV_cannot_create_file, if the transient volume directory is not defined or does not exist.
Possibly other errors.

Parameters

dataset_tag	(I) Tag of the dataset
item_id	(I) Item (Product) ID, passed as string
rev	(I) Revision of the Item (Product) selected
svr	(I) Saved Variant Rule (SVR) as IMAN_specification. NULL or string "NULL" should be passed if SVR is not used
entity_handle	(I) The UG occurrence entity handles entered as a single string, separated using the comma character (,). If empty string ("") is passed, this ITK will create empty pruned PLM file
nb_of_targets	(I) Number of target entity handles. This parameter is not used
target_lines	(I) Target entity handles entered as a single string, separated using the comma character (,). NULL or empty string ("") should be passed if target lines are not used for search
voo_flag	(I) Valid Overlays Only (VOO) flag. Valid values for this flag: TRUE: Valid Overlays will be applied while configuring the structure FALSE: Valid Overlays will not be applied while configuring the structure
plmxml_config_file	(OF) Name of the configured pruned PLM file
file_location	(OF) Location of pruned PLM file

RDV_API int RDV_config_plmxml_mfk	(	tag_t	dataset_tag,
		tag_t	product_revision_tag,
		char *	svr,
		char *	entity_handle,
		char *	target_lines,
		logical	voo_flag,
		char **	plmxml_config_file,
		char **	file_location
	)

This method generates a configured plmxml file from the unconfigured plmxml file, applying the saved variant rule. This function is called from Adhoc DC thin client. This ITK is needed for MFK environment where Item ID might not be unique. In this case item UID is used to retrieve the item revision tag and this is passed as input. of the item is required to be passed.

The function returns:

ITK_ok on success
RDV_illegal_parameter, if entity_handle parameter is NULL.
POM_invalid_tag, if an invalid tag or NULLTAG is passed in Dataset tag or Item (Product) revision tag.
RDV_cannot_create_file, if the transient volume directory is not defined or does not exist.
Possibly other errors.

Parameters

dataset_tag	(I) Tag of the dataset
product_revision_tag	(I) Tag of the Item (Product) revision
svr	(I) Saved Variant Rule (SVR) as IMAN_specification. NULL or string "NULL" should be passed if SVR is not used
entity_handle	(I) The UG occurrence entity handles entered as a single string, separated using the comma character (,). If empty string ("") is passed, this ITK will create empty pruned PLM file
target_lines	(I) Target entity handles entered as a single string, separated using the comma character (,). NULL or empty string ("") should be passed if target lines are not used for search
voo_flag	(I) Valid Overlays Only (VOO) flag. Valid values for this flag: TRUE: Valid Overlays will be applied while configuring the structure FALSE: Valid Overlays will not be applied while configuring the structure
plmxml_config_file	(OF) Name of the configured pruned PLM file
file_location	(OF) Location of pruned PLM file

RDV_API int RDV_config_plmxml_with_import	(	tag_t	dataset_tag,
		tag_t	revid_tag,
		char *	directoryName,
		int *	svrCount,
		char **	svr,
		char *	importUtility,
		char *	importUtilityParameter,
		char *	logFileImport
	)

Parameters

dataset_tag	(I)
revid_tag	(I)
directoryName	(I)
svrCount	(I)
svr	(I)
importUtility	(I)
importUtilityParameter	(I)
logFileImport	(I)

RDV_API int RDV_config_plmxml_with_svr	(	tag_t	dataset_tag,
		tag_t	toprev,
		char *	directoryName,
		int *	svrCount,
		char **	svr
	)

Parameters

dataset_tag	(I)
toprev	(I)
directoryName	(I)
svrCount	(I)
svr	(I)

RDV_API int RDV_config_plmxml_with_svr_with_log	(	tag_t	datasetTag,
		tag_t	toprev,
		char *	directory,
		int *	svrCount,
		char **	svr,
		char *	logFileImport
	)

Parameters

datasetTag	(I)
toprev	(I)
directory	(I)
svrCount	(I)
svr	(I)
logFileImport	(I)

RDV_API int RDV_context_add_object	(	tag_t	obj,
		int *	n_added_objects,
		tag_t **	added_objects
	)

This call will process Teamcenter Engineering objects to add them to the RDV context. Depending on the preference values for:

PortalDesignContextECObject.TYPE
PortalDesignContextECObject.WorkPartProperties
PortalDesignContextECObject.WorkPartRelationships
PortalDesignContextExcludedWorkPart.Types
PortalDesignContextProductItemProperties
PortalDesignContextProcess.WorkPartProperties
PortalDesignContextProcess.WorkPartOrChangeAttachmentTypes

Additional objects may be automatically added along with the input object.

Parameters

obj	(I) The object that is to be added to the currently active RDV context
n_added_objects	(O) The number of objects that were added to the currently active RDV context as a result of this call
added_objects	(OF) n_added_objects The objects that were added to the currently active RDV context as a result of this call

RDV_API int RDV_context_ask_bom_window ( tag_t * bom_window )

This call will return a reference to the BOM window used by the RDV search engine. If no BOM window exists yet, the BOM window will be created if the context is searchable.

Parameters

bom_window (O) The BOM window used by the RDV search engine

RDV_API int RDV_context_ask_context ( RDV_context_t * rdv_context_object )

This call will return a reference to the currently active RDV context.

When building applications using this API you may use this call to obtain a reference to the currently active context in order swap it back in at a later time using RDV_context_set_context(). It is recommended to place a call to RDV_context_set_context() with a NULL object in order to avoid overwriting the obtained external reference to the RDV context by subsequent calls.

A typical sequence of calls allowing for building a second context while maintaining a valid reference to the first context is shown below:

ifail = RDV_context_ask_context( &context_1 );
ifail = RDV_context_set_context( NULL );
ifail = RDV_context_ask_context( &context_2 );
ifail = RDV_context_set_context( context_1 );

Parameters

rdv_context_object (O) Returns a reference to the currently active RDV context

RDV_API int RDV_context_ask_objects	(	RDV_object_type_token	type_token,
		int *	n_objects,
		tag_t **	objects
	)

This call will return the list of objects in the current RDV context. The following type tokens are available to request only a subset of objects:

RDV_object_type_all
RDV_object_type_product_itemrev
RDV_object_type_work_part_item
RDV_object_type_eng_change
RDV_object_type_workflow_process
RDV_object_type_revision_rule
RDV_object_type_variant_rule
RDV_object_type_structurecontext
RDV_object_type_configcontext

Parameters

type_token	(I) A token that specifies the object type of objects to return. Several tokens may be combined, e.g. RDV_object_type_product_itemrev \| RDV_object_type_work_part_item
n_objects	(O) The number of output objects
objects	(O) n_objects The output object array may contain WorkParts Items, Product ItemRevisions, Workflow processes, Engineering Changes, VariantRules, RevisionRules, Structure Context objects, and/or Configuration Context objects, depending on the provided type_token.

RDV_API int RDV_context_ask_search_engine ( RDV_search_engine_t * search_engine )

This call will return a reference to the search engine of the current RDV context.

Parameters

search_engine (O) A reference to the currently active search engine

RDV_API int RDV_context_clear ( )

This call releases memory allocated to the currently active context. The context is set to NULL as a result to this call. It is safe to call this on NULL contexts.

As an example, Web applications in RDV use this call to reset the currently active RDV context each time a new HTML frame containing RDV action icons is loaded, e.g. for folders, envelopes, ItemRevisions, or Workflow Processes. This releases any resources, e.g. memory, allocated to a potentially existing RDV context

Restrictions:

You should not call this function if there are references to the current context held outside the RDV ITK module. Calling RDV_context_clear will invalidate these references. Use RDV_context_set_context(NULL) instead.

RDV_API int RDV_context_default_prox_search	(	int *	n_target_bom_lines,
		tag_t **	target_bom_lines,
		int *	n_unconfigured_target_bom_lines,
		tag_t **	unconfigured_target_bom_lines,
		int *	n_unconfigurable_target_bom_lines,
		tag_t **	unconfigurable_target_bom_lines,
		int *	n_background_bom_lines,
		tag_t **	background_bom_lines,
		int *	n_unconfigured_background_bom_lines,
		tag_t **	unconfigured_background_bom_lines,
		int *	n_unconfigurable_background_bom_lines,
		tag_t **	unconfigurable_background_bom_lines
	)

This call provides a convenient interface to perform a default search on the currently active context. This call will search for all WorkPart instances and their near-by component instances within the distance provided in the preference WebDesignContextDefaultSearchDistance.

This call is based on lower level APIs to the search engine. It provides an abstraction layer hiding the implementation of the search engine, e.g. UG based QPL versus JT based QPL search engines, or PSE appearance search engines.

This call provides a detailed output in terms of various types of bomlines. BOMLines may basically be target or background BOMLines. It is further drilled down by this call into bomlines, which were found but could not be configured because of the revision rule, variant rule or effectivity settings.

Restrictions:

The call will fail, if the currently active RDV context is not proximity searchable. See also RDV_context_is_proximity_searchable().

Parameters

n_target_bom_lines	(O)
target_bom_lines	(OF) n_target_bom_lines
n_unconfigured_target_bom_lines	(O)
unconfigured_target_bom_lines	(OF) n_unconfigured_target_bom_lines
n_unconfigurable_target_bom_lines	(O)
unconfigurable_target_bom_lines	(OF) n_unconfigurable_target_bom_lines
n_background_bom_lines	(O)
background_bom_lines	(OF) n_background_bom_lines
n_unconfigured_background_bom_lines	(O)
unconfigured_background_bom_lines	(OF) n_unconfigured_background_bom_lines
n_unconfigurable_background_bom_lines	(O)
unconfigurable_background_bom_lines	(OF) n_unconfigurable_background_bom_lines

RDV_API int RDV_context_is_proximity_searchable ( logical * is_searchable )

This call can be used to find out whether the currently active RDV context allows to search by proximity. For example Web applications in RDV use this call to determine whether or not to add a new action icon for DesignContext searches when a new HTML frame containing RDV action icons is loaded, e.g. for folders, envelopes, ItemRevisions, or Workflow Processes. The following criteria will control whether or not a context is searchable:

The context must at least contain one WorkPart.
The context must contain a Product ItemRevision
If no RevisionRule is set, the default RevisionRule applies
It must be possible to instantiate a search engine for the Product ItemRevision, RevisionRule, and VariantRule combination

Parameters

is_searchable (O) True if the currently active context is proximity searchable

RDV_API int RDV_context_is_searchable ( logical * is_searchable )

This call will determine whether the currently active RDV context is searchable. The following criteria will control whether or not a context is searchable:

If the preference PortalDesignContextAllowNoWorkParts is set to 0, the context must at least contain one WorkPart.
The context must contain a Product ItemRevision
If no RevisionRule is set, the default RevisionRule applies
It must be possible to instantiate a search engine for the Product ItemRevision, RevisionRule, and VariantRule combination

Parameters

is_searchable (O) True if the currently active context is searchable

RDV_API int RDV_context_remove_object ( tag_t object )

This call will remove the object from the current RDV context.

Parameters

object (I) The object to remove

RDV_API int RDV_context_set_bom_window ( tag_t bom_window )

This call will set the BOM window, which is to be used by the RDV search engine.

Parameters

bom_window (I) The BOM window to be used by the RDV search engine

RDV_API int RDV_context_set_context ( RDV_context_t rdv_context_object )

This call will set the currently active RDV context, replacing potentially existing context.

When building applications using this API you may use this call to swap in a previously created context. Calling RDV_context_set_context() with a NULL object will prevent external references to RDV contexts to be overwritten by subsequent calls

At typical sequence of calls allowing for building a second context while maintaining a valid reference to the first context is shown below:

ifail = RDV_context_ask_context( &context_1 );
ifail = RDV_context_set_context( NULL );
ifail = RDV_context_ask_context( &context_2 );
ifail = RDV_context_set_context( context_1 );

Restrictions:

The parameter rdv_context_object may by NULL. Otherwise it must have been obtained by an earlier call to RDV_context_ask_context().

Parameters

rdv_context_object (I) The RDV context to set

RDV_API int RDV_context_set_objects	(	int	n_objects,
		tag_t *	objects
	)

This call will set the RDV context objects, bypassing the additional logic in RDV_context_add_object().

Parameters

n_objects	(I) The number of input objects
objects	(O) n_objects The input object array may contain Items and ItemRevisions for WorkParts and Product Items, Workflow processes, Engineering Changes, VariantRules and/or RevisionRules, Structure Context objects and Configuration Context objects.

RDV_API int RDV_create_base_options	(	tag_t	product,
		const char *	option_name,
		const char *	option_value,
		tag_t *	opt_tag,
		tag_t *	opt_rev
	)

Parameters

product	(I)
option_name	(I)
option_value	(I)
opt_tag	(O)
opt_rev	(O)

RDV_API int RDV_create_nve_from_formula	(	const char *	code,
		const char *	desc,
		const char *	productName,
		const char *	productNamespace,
		const char *	formula,
		int	op,
		const char *	comment,
		tag_t *	newNVETag
	)

RDV_API char* RDV_escape_xml_tag_value ( const char * value )

Parameters

value (I)

RDV_API int RDV_execute_eng_change_query	(	char *	item_id,
		char *	item_revision_id,
		int *	n_instances,
		tag_t **	instances
	)

Parameters

item_id	(I)
item_revision_id	(I)
n_instances	(O)
instances	(OF) n_instances

RDV_API int RDV_execute_processes_query	(	char *	object_name,
		int *	n_instances,
		tag_t **	instances
	)

Parameters

object_name	(I)
n_instances	(O)
instances	(OF) n_instances

RDV_API int RDV_execute_search	(	RDV_search_engine_id_t	engine_id,
		tag_t	search_criteria,
		int *	n_results,
		char ***	results
	)

This function executes a search using the specified search engine.

Parameters

engine_id	(I) The ID of the search engine to use for this call. A search engine can be instantiated by calling RDV_find_search_engine(). If the currently active context is searchable (use RDV_context_is_searchable()) the search engine can also be obtained by calling RDV_context_ask_search_engine(). The search engine ID is available through RDV_search_engine_ask_id().
search_criteria	(I) The tag of the search criteria object. Usually this is a tag to a criteria group object.
n_results	(O) The number of search criteria matches
results	(OF) n_results Search criteria matches. These matches can be converted to BOM lines using RDV_map_search_results_to_bom().

RDV_API int RDV_execute_workparts_query	(	char *	item_id,
		int *	n_instances,
		tag_t **	instances
	)

Parameters

item_id	(I)
n_instances	(O)
instances	(OF) n_instances

RDV_API int RDV_export_config_nx_assembly	(	int	targetCount,
		tag_t *	targetList,
		int	backgrndCount,
		tag_t *	backgrndList,
		logical	checkoutTargets,
		char *	namingFormat,
		char **	zipfilename,
		char **	logfilename
	)

Parameters

targetCount	(I)
targetList	(I) targetCount
backgrndCount	(I)
backgrndList	(I) backgrndCount
checkoutTargets	(I)
namingFormat	(I)
zipfilename	(OF)
logfilename	(OF)

RDV_API int RDV_export_config_nx_structure	(	int	targetCount,
		tag_t *	targetLines,
		int	backgroundCount,
		tag_t *	backgroundLines,
		logical	checkoutTargets,
		char *	namingFormat,
		char **	zipFileTicket,
		char **	logFileTicket
	)

Parameters

targetCount	(I)
targetLines	(I) targetCount
backgroundCount	(I)
backgroundLines	(I) backgrndCount
checkoutTargets	(I)
namingFormat	(I)
zipFileTicket	(OF)
logFileTicket	(OF)

RDV_API int RDV_find_imprecise_abe	(	char *	gcId,
		tag_t	topArchTag,
		tag_t	bomWindowTag,
		int *	noOfMeapns,
		tag_t **	meApns,
		char ***	genCompId,
		char ***	compDesc
	)

Parameters

gcId	(I)
topArchTag	(I)
bomWindowTag	(I)
noOfMeapns	(O)
meApns	(OF)
genCompId	(OF)
compDesc	(OF)

RDV_API int RDV_find_precise_abe	(	char *	gcId,
		tag_t	topArchTag,
		tag_t	bomWindowTag,
		int *	noOfMeapns,
		tag_t **	meApns,
		char ***	genCompId,
		char ***	compDesc
	)

Parameters

gcId	(I)
topArchTag	(I)
bomWindowTag	(I)
noOfMeapns	(O)
meApns	(OF)
genCompId	(OF)
compDesc	(OF)

RDV_API int RDV_find_search_engine	(	tag_t	product_item_rev,
		tag_t	revision_rule,
		tag_t	variant_rule,
		tag_t	bom_window,
		RDV_search_engine_t *	search_engine
	)

This call returns a reference to the RDV search engine of the currently active RDV context.

Restrictions:

You should either specify the parameters product_item_rev, revision_rule, and variant_rule, or the bom_window parameter. If you specify both sets of parameters, the call will not complete successfully if the input parameters are conflicting (e.g. product_item_rev does not correspond to the provided bom_window). You may use NULLTAG for parameters you don't want to set.

Parameters

product_item_rev	(I) The ItemRevision of the product for which a search engine is to be instantiated
revision_rule	(I) The revision rule for which the requested search engine should be valid, if NULL, the default revision rule will be assumed
variant_rule	(I) The variant rule for which the requested search engine should be valid. May be NULL.
bom_window	(I) The BOM window for which a search engine is to be instantiated
search_engine	(OF) A reference to the requested search engine

RDV_API int RDV_formattr_srch_crt_create	(	const char *	relationtype,
		int	parentType,
		const char *	formType,
		const char *	logicalOpr,
		const char *	propertyName,
		const char *	mathOpr,
		const char *	propType,
		int	sizeOfValues,
		const char **	value,
		tag_t *	scFormAttrObjTag
	)

This function is used for creating a Search Criteria Form Attribute object. It takes the criteria object type, relation type, parent type, form type logical operator, property name, property type, comparator and value.

It returns the tag of the resulting Form Attribute Search Criteria object.

Parameters

relationtype	(I) Type of Relation e.g "Reference"
parentType	(I) 1 if Item, 0 if Item Revision
formType	(I) Form type
logicalOpr	(I) Logical operator, e.g "AND", "OR"
propertyName	(I) Name of the property
mathOpr	(I) The comparator
propType	(I) Type of property, e.g. "StringType", "DateType"
sizeOfValues	(I) Length of Array of strings
value	(I) sizeOfValues Array of strings
scFormAttrObjTag	(O) The resulting search criteria object. The object will not be persistently saved until you call AOM_save().

RDV_API int RDV_formattr_srch_crt_get_attrs	(	tag_t	scFormAttrObjTag,
		char **	relationtype,
		int *	parentType,
		char **	formType,
		char **	logicalOpr,
		char **	propertyName,
		char **	mathOpr,
		char **	propType,
		int *	sizeOfValues,
		char ***	values
	)

This function is used for retrieving the relation type, parent type, form type logical operator, property name, property type, comparator and value from a Search Criteria Form Attribute object.

Parameters

scFormAttrObjTag	(I) The form attribute search criteria object
relationtype	(OF) Type of Relation e.g "Reference"
parentType	(O) 1 if Item, 0 if Item Revision
formType	(OF) Form type
logicalOpr	(OF) Logical operator, e.g "AND", "OR"
propertyName	(OF) Name of the property
mathOpr	(OF) The comparator
propType	(OF) Type of property, e.g. "StringType", "DateType"
sizeOfValues	(O) Length of Array of strings
values	(0F) sizeOfValues Array of strings

RDV_API int RDV_generate_PLMXML_file	(	int	numberOfBOMLines,
		int	numOfSelectedBL,
		tag_t *	bomLineTags,
		tag_t *	selectedBLTags,
		tag_t	bomWindow,
		char **	genFileName
	)

Parameters

numberOfBOMLines	(I)
numOfSelectedBL	(I)
bomLineTags	(I) numberOfBOMLines
selectedBLTags	(I) numOfSelectedBL
bomWindow	(I)
genFileName	(OF)

RDV_API int RDV_generate_pruned_plmxml	(	tag_t	datasetTag,
		tag_t	prodRevTag,
		tag_t	window,
		tag_t	svrTag,
		char *	entityHandles,
		int	noOfTargetLines,
		tag_t *	targetLines,
		logical	vooFlag,
		char **	pruneFilePath
	)

Parameters

datasetTag	(I)
prodRevTag	(I)
window	(I)
svrTag	(I)
entityHandles	(I)
noOfTargetLines	(I)
targetLines	(I) noOfTargetLines
vooFlag	(I)
pruneFilePath	(OF) filepath

RDV_API void RDV_generate_tempfilename	(	char *	prefix,
		char **	fileName
	)

Parameters

prefix	(I)
fileName	(OF)

RDV_API int RDV_generate_variant_map	(	tag_t	datasetTag,
		char **	revisionRule,
		char **	productId
	)

Parameters

datasetTag	(I)
revisionRule	(O)
productId	(O)

RDV_API int RDV_get_apn_for_top_arch_and_bomwindow	(	char *	gcId,
		tag_t	topArchTag,
		tag_t	bomWindowTag,
		int *	noOfMeapns,
		tag_t **	meApns,
		char ***	genCompId,
		char ***	compDesc
	)

Parameters

gcId	(I)
topArchTag	(I)
bomWindowTag	(I)
noOfMeapns	(O)
meApns	(OF)
genCompId	(OF)
compDesc	(OF)

RDV_API int RDV_get_arch_bomline_comps	(	tag_t	topLevelItem,
		tag_t	meApn,
		tag_t	bomWindowTag,
		int *	noOfChildComponents,
		tag_t **	childMeapns,
		tag_t **	bomLines
	)

Parameters

topLevelItem	(I)
meApn	(I)
bomWindowTag	(I)
noOfChildComponents	(O)
childMeapns	(OF)
bomLines	(OF)

RDV_API int RDV_get_arch_meapnchild_components	(	tag_t	topLevelItem,
		tag_t	meApn,
		tag_t	bomWindowTag,
		int *	noOfChildComponents,
		char ***	componentsGcid,
		char ***	componentsName,
		tag_t **	childMeapns
	)

Parameters

topLevelItem	(I)
meApn	(I)
bomWindowTag	(I)
noOfChildComponents	(O)
componentsGcid	(OF) noOfChildComponents
componentsName	(OF) noOfChildComponents
childMeapns	(OF) noOfChildComponents

RDV_API int RDV_get_bomline_prop_chain	(	tag_t	bomLine,
		char *	bomLineProp,
		logical	is_string_prop,
		logical	is_reference_prop,
		int *	noOfProps,
		char ***	props,
		int *	noOfBomLines,
		tag_t **	bomLines
	)

RDV_API int RDV_get_checkfilename_for_web ( char ** checkfilename )

Parameters

checkfilename (OF)

RDV_API int RDV_get_imprecise_abe_child_apns	(	tag_t	topLevelItem,
		tag_t	meApn,
		tag_t	bomWindowTag,
		int *	noOfChildComponents,
		char ***	componentsGcid,
		char ***	componentsName,
		tag_t **	childMeapns
	)

(OF) noOfChildComponents

Parameters

topLevelItem	(I)
meApn	(I)
bomWindowTag	(I)
noOfChildComponents	(O)
componentsGcid	(OF) noOfChildComponents
componentsName	(OF) noOfChildComponents

RDV_API int RDV_get_Occurences_id	(	tag_t	datasetTag,
		char *	entity_handle,
		char **	retChar
	)

Parameters

datasetTag	(I)
entity_handle	(I)
retChar	(OF) occurrences

RDV_API int RDV_get_precise_abe_child_apns	(	tag_t	topLevelItem,
		tag_t	meApn,
		tag_t	bomWindowTag,
		int *	noOfChildComponents,
		char ***	componentsGcid,
		char ***	componentsName,
		tag_t **	childMeapns
	)

(OF) noOfChildComponents

Parameters

topLevelItem	(I)
meApn	(I)
bomWindowTag	(I)
noOfChildComponents	(O)
componentsGcid	(OF) noOfChildComponents
componentsName	(OF) noOfChildComponents

RDV_API int RDV_get_rev_rule	(	char *	fileBuff,
		char **	revRulename
	)

Parameters

fileBuff	(I)
revRulename	(OF) revrule

RDV_API int RDV_get_site_pref_values	(	const char *	pref_name,
		int *	num_pref_values,
		char ***	pref_values
	)

This method returns the Preference Values provided the Preference name is the input

Parameters

pref_name	(I)
num_pref_values	(O)
pref_values	(OF) num_pref_values

RDV_API int RDV_get_unconf_bom_lines_indexes	(	int	n_bom_lines,
		tag_t *	bom_lines,
		logical	showsUnconfiguredByDate,
		logical	showsUnconfiguredVariants,
		int *	n_indexes,
		int **	indexes
	)

Parameters

n_bom_lines	(I)
bom_lines	(I) n_bom_lines
showsUnconfiguredByDate	(I)
showsUnconfiguredVariants	(I)
n_indexes	(O)
indexes	(OF) n_indexes

RDV_API int RDV_get_valid_overlay_bom_lines	(	const logical	show_unconfigured_variant,
		const logical	show_unconfigured_by_date,
		const int	n_variant_rules,
		const tag_t *	variant_rules,
		int *	n_backgrnd_bomlines,
		tag_t *	backgrnd_bomlines,
		int *	n_unconfigured_bom_lines,
		tag_t **	unconfigured_bom_lines
	)

Parameters

show_unconfigured_by_date	(I)
n_variant_rules	(I)
variant_rules	(I)
n_backgrnd_bomlines	(I)
backgrnd_bomlines	(I/O)
n_unconfigured_bom_lines	(I/O)
unconfigured_bom_lines	(O) (OF)

RDV_API int RDV_getbomlinesfromAbsoluteOccUIDs	(	char **	absolute_occurrence_uids,
		int	num_of_absolute_occurrence_uids,
		tag_t	bomWindow,
		tag_t **	bomlines,
		int *	bomlineCount
	)

This method returns the bomlines for an array of absolute occurrence Ids.

Parameters

absolute_occurrence_uids	(I) Array of Abs Occ UIDs
num_of_absolute_occurrence_uids	(I) Length of array of abs occ uids
bomWindow	(I) input BOMWindow
bomlines	(OF) Output array containing BOMLines
bomlineCount	(O) Count of output BOMLines

RDV_API int RDV_getbomlinesfromapprpathnodeUIDs	(	char **	appr_path_node_uid,
		int	localapprUIDLength,
		tag_t	bomWindow,
		tag_t **	bomlines,
		int *	bomlineCount
	)

This method returns the bomlines for an array of appearance pathnode UID's This method takes APN UID in the format ""xysadretw7rtye"" instead of "xysadretw7rtye"

Parameters

appr_path_node_uid	(I) Input ApprPathNodes
localapprUIDLength	(I) Number of input ApprPathNodes
bomWindow	(I) Input BOMWindow
bomlines	(OF) Output array containing BOMLines
bomlineCount	(O) Count of output BOMLines

RDV_API int RDV_getIssues	(	char *	resultsFile,
		char ***	issuesArray,
		int *	issuesArrayLen
	)

This method parses a specific file and converts the complete file into a single array

Parameters

resultsFile	(I)
issuesArray	(OF) issuesArrayLen
issuesArrayLen	(O)

RDV_API int RDV_getRevision_fromDataset	(	tag_t	dataset_tag,
		char **	revisionRule
	)

Parameters

dataset_tag	(I)
revisionRule	(OF) file_location

RDV_API int RDV_getTempFileName	(	char *	prefix,
		char **	tempFileName
	)

Parameters

prefix	(I)
tempFileName	(OF)

RDV_API int RDV_grp_srch_crt_create	(	tag_t	typeTag,
		int	noOfSearchCriterias,
		const tag_t *	search_criterias,
		int	op,
		tag_t *	scGrpObjTag
	)

This function is used for creating a Search Criteria Grouping object. It takes the tags of Search Criteria objects and attaches them to the Search Criteria Grouping object. The operator joining the individual search criteria is also taken and stored inside the Search Criteria Grouping object.

Parameters

typeTag	(I) The object type tag for the search criteria object. The type tag can be obtained by calling TCTYPE_find_type(), e.g. TCTYPE_find_type( "ApprSearchCriteriaGroup", "ApprSearchCriteriaGroup", &my_type_tag )
noOfSearchCriterias	(I) The number of search criteria that are to be grouped together
search_criterias	(I) noOfSearchCriterias The search criteria that are to be grouped together
op	(I) The logical operator with which the search criteria that are to be grouped together. Can be one of the following POM tokens: POM_and POM_or
scGrpObjTag	(O) The resulting search criteria object. The object will not be persistently saved until you call AOM_save().

RDV_API int RDV_grp_srch_crt_get_attrs	(	tag_t	scGrpObjTag,
		int *	op,
		int *	noOfSubCriteria,
		tag_t **	subCriteria
	)

This function is used for retrieving the Search Criteria objects from the Search Criteria Grouping object. This also returns the number of Search Criteria objects being referenced by the Grouping object and the operator used to combine them.

Parameters

scGrpObjTag	(I) The search criteria object
op	(O) The logical operator with which sub- criteria are grouped together. Can be one of the following POM tokens: POM_and POM_or
noOfSubCriteria	(O) The number of sub-criteria objects
subCriteria	(OF) noOfSubCriteria Sub-criteria objects in this criteria grouping

RDV_API int RDV_inclass_srch_crt_create	(	tag_t	typeTag,
		tag_t	icsClass,
		int	icsOptions,
		int	noOfUncts,
		const int *	uncts,
		const char **	unctValues,
		tag_t *	scInClassObjTag
	)

This function is used for creating a Search Criteria Classification object. It takes in the IcsClass, icsOprions and unct information and stores them inside the Search Criteria Classification object.

Parameters

typeTag	(I) The object type tag for the search criteria object. The type tag can be obtained by calling TCTYPE_find_type(), e.g. TCTYPE_find_type( "ApprSearchCriteriaInClass", "ApprSearchCriteriaInClass", &my_type_tag )
icsClass	(I) Classification class name
icsOptions	(I) Classification options
noOfUncts	(I) Number of Classification attribute IDs
uncts	(I) noOfUncts List of Classification attribute IDs
unctValues	(I) noOfUncts List of Classification attribute values (incl. comparator).
scInClassObjTag	(O) The resulting search criteria object. The object will not be persistently saved until you call AOM_save().

RDV_API int RDV_inclass_srch_crt_get_attrs	(	tag_t	scInClassObjTag,
		tag_t *	icsClass,
		int *	icsOptions,
		int *	noOfUncts,
		int **	uncts,
		char ***	unctValues
	)

This function is used for retrieving attribute information from Search Criteria Classification Filter object.

Parameters

scInClassObjTag	(I) The search criteria object
icsClass	(O) Classification class name
icsOptions	(O) Classification options
noOfUncts	(O) Number of Classification attribute IDs
uncts	(OF) noOfUncts List of Classification attribute IDs
unctValues	(OF) noOfUncts List of Classification attribute values (incl. comparator)

RDV_API int RDV_init ( )

The call will cause all preferences to be reinitialized as part of the next RDV ITK call. This call should be used after changing RDV preferences to activate the new settings.

For example Web applications in RDV use this call to reset the currently active RDV context each time a new HTML frame containing RDV action icons is loaded, e.g. for folders, envelopes, ItemRevisions, or Workflow Processes. This causes all preferences to refresh upon invoking the next RDV / Web function. Changes to user preference settings, e.g. the requested proximity search distance, will therefore be immediately effective in the next RDV / Web function

RDV_API int RDV_is_ia_by_bomline_prop	(	tag_t	bom_line,
		logical *	is_IA
	)

This call checks if a BOMLine is an Installation Assembly by checking the value of the property on it defined by the preference PortalDesignContextIsInstallationAssemblyMethod.has_bomline_prop.name against the value definaed by the preference PortalDesignContextIsInstallationAssemblyMethod.has_bomline_prop.value

Parameters

bom_line	(I) The BOMLine that will be checked
is_IA	(O) The verdict being returned

RDV_API int RDV_is_ia_by_ir_type	(	tag_t	bom_line,
		logical *	is_IA
	)

This call checks if a BOMLine is an Installation Assembly BOMLine by checking ItemRevision type against the value defined in the PortalDesignContextIsInstallationAssemblyMethod.hasIRType.Type preference.

Parameters

bom_line	(I) The BOMLine that will be checked
is_IA	(O) The verdict being returned

RDV_API int RDV_is_ia_by_preciseness	(	tag_t	bom_line,
		logical *	is_IA
	)

This call checks if a BOMLine is an Installation Assembly BOMLine by checking for a precise BOMViewRevision.

Parameters

bom_line	(I) The BOMLine that will be checked
is_IA	(O) The verdict being returned

RDV_API int RDV_is_ia_by_transform	(	tag_t	bom_line,
		logical *	is_IA
	)

This function checks if a BOMLine is an Installation Assembly BOMLine by checking the transformation matrix for each component. It returns true if at least one occurrence below this BOMLine has a transformation matrix different than the identity matrix.

Parameters

bom_line	(I) The BOMLine that will be checked
is_IA	(O) The verdict being returned

RDV_API int RDV_is_installation_assembly	(	tag_t	bomLine,
		logical *	is_ia
	)

Parameters

bomLine	(I)
is_ia	(O)

RDV_API int RDV_is_part_shared	(	tag_t	apn_tag,
		logical *	is_shared,
		int *	no_of_refs
	)

Parameters

apn_tag	(I) > *
is_shared	(O) > *
no_of_refs	(O) > *

RDV_API int RDV_is_product_item	(	tag_t	item,
		logical *	is_product_item
	)

This call checks whether the input item is a Product Item by checking all properties defined in the PortalDesignContextProductItemProperties preference.

Deprecated:: This function is deprecated, it will be removed from Teamcenter 11. From Tc9.0 onwards, please use ITEM_is_product_item.

Parameters

item	(I) The item tag to be checked
is_product_item	(O) TRUE if the item is a product item

RDV_API int RDV_map_search_results_to_bom	(	tag_t	bom_window,
		int	n_stringsToMatch,
		const char **	stringsToMatch,
		int *	n_bomlines,
		tag_t **	bom_lines,
		int *	n_unconfigured_matches,
		tag_t **	unconfigured_matches,
		int *	n_unconfigurable_bom_lines,
		tag_t **	unconfigurable_bom_lines
	)

This call will convert RDV search engine matches into BOM lines. Converting search engine matches to configured BOM windows involves loading and expanding the BOM tree as needed for the mapped results.

RDV search engine matches are returned by calls to RDV_execute_search().

The call returns BOM lines in 3 different arrays.

The 1st array returns BOM lines corresponding to search results that were successfully mapped to the BOM window.

The 2nd array returns BOM lines that were successfully mapped but are not valid for the configuration setting of the current BOM window with respect to effective date (Occurrence Effectivity) and/or variant option settings. This could be a result of searching for near-by components of the left hand drive steering column which might return the right hand drive glove box. Provided that a left hand drive variant rule is in effect the right hand drive glove box will be returned in the 2nd array in this case.

The 3rd array returns BOM lines, which encountered error conditions during the process of being mapped to the BOMWindow. This could be the result of failing to configure a revision of the corresponding component Item or one of its parent Items if the structure was changed since the last update to the search index. Another reason could be that a component was removed from the structure since the search index was last updated. For each search result failing to map to the BOM window the closest successfully mapped parent is returned. This could mean that some parents are returned multiple times. The following condition will always be met:

n_search_results = n_bom_lines + n_unconfigured_bom_lines + n_unconfigurable_bom_lines

Parameters

bom_window	(I) The BOM window to which the results are to be mapped. If a NULLTAG is passed, it will default to the search engine BOMWindow as obtained by a call to RDV_context_ask_bom_window().
n_stringsToMatch	(I) Number of search results to convert
stringsToMatch	(I) Search results to convert
n_bomlines	(O) Number of converted bom lines
bom_lines	(OF) n_bomlines Converted bom lines
n_unconfigured_matches	(O) BOM lines corresponding to search results, which don�t configure for the current effective date or variant rule.
unconfigured_matches	(OF) n_unconfigured_matches BOM lines corresponding to search results, which don�t configure for the current effective date or variant rule.
n_unconfigurable_bom_lines	(O) Number of search results corresponding to BOM lines for which no revision configures or for which other errors were encountered.
unconfigurable_bom_lines	(OF) n_unconfigurable_bom_lines BOM lines corresponding to search results for which no revision configures or for which other errors were encountered. The BOM line on which the error was encountered is given. This may be the BOM line that corresponds to the search result or a parent BOM line thereof

RDV_API int RDV_mapattr_srch_crt_create	(	tag_t	typeTag,
		const char *	name,
		const char *	value,
		int	op,
		tag_t *	scMappAttrObjTag
	)

This function is used for creating a Search Criteria Mapped Attribute object. It takes the criteria object type, mapped attribute name and value (e.g. for a occurrence note), and the comparator. It returns the tag of the resulting Mapped Attribute Search Criteria object.

Parameters

typeTag	(I) The object type tag for the search criteria object. The type tag can be obtained by calling TCTYPE_find_type(), e.g. TCTYPE_find_type( "ApprSearchCriteriaMapAttr", "ApprSearchCriteriaMapAttr", &my_type_tag )
name	(I) The name of the attribute to search by
value	(I) The value this criterion requires
op	(I) The comparator. Can be a combination of one or more of POM_not POM_is_equal_to POM_is_greater_than POM_is_less_than POM_is_null POM_is_like
scMappAttrObjTag	(O) The resulting search criteria object. The object will not be persistently saved until you call AOM_save().

RDV_API int RDV_mapattr_srch_crt_get_attrs	(	tag_t	scMapAttrObjTag,
		char **	name,
		int *	op,
		char **	value
	)

This function is used for retrieving the name, value and operator from a Search Criteria Mapped Attribute object.

Parameters

scMapAttrObjTag	(I) The mapped attribute search criteria object
name	(OF) The name of the mapped attribute
op	(O) The comparator. Can be a combination of one or more of: POM_not POM_is_equal_to POM_is_greater_than POM_is_less_than POM_is_null POM_is_like
value	(OF) The required value for the mapped attribute

RDV_API int RDV_named_variant_expr_create	(	const char *	code,
		const char *	desc,
		tag_t	var1,
		tag_t	var2,
		int	op,
		const char *	comment,
		tag_t *	newNVETag
	)

This method creates a Named Variant Expression based on code(unique name), description, constituent variant Expressions, operator and comment.

Parameters

code	(I)
desc	(I)
var1	(I)
var2	(I)
op	(I)
comment	(I)
newNVETag	(O)

RDV_API int RDV_named_variant_expr_get_attrs	(	tag_t	nveObjTag,
		char **	code,
		char **	desc,
		int *	fp,
		tag_t *	var1,
		tag_t *	var2,
		int *	op,
		char **	comment,
		int *	no_of_literals,
		tag_t **	literals
	)

This method retrieves the constituent attributes from a Named Variant Expression Object.

Parameters

nveObjTag	(I)
code	(OF)
desc	(OF)
fp	(O)
var1	(O)
var2	(O)
op	(O)
comment	(OF)
no_of_literals	(O)
literals	(OF) no_of_literals

RDV_API int RDV_namedzone_srch_crt_create	(	tag_t	typeTag,
		const char *	name,
		int	op,
		tag_t *	scNamedZoneObjTag
	)

This function is used for creating a Search Criteria Named Zone object. It takes the criteria object type, the name of the zone, and the comparator. It returns the tag of the resulting named zone search criteria object

Parameters

typeTag	(I) The object type tag for the search criteria object. The type tag can be obtained by calling TCTYPE_find_type(), e.g. TCTYPE_find_type( "ApprSearchCriteriaNamedZone", "ApprSearchCriteriaNamedZone", &my_type_tag )
name	(I) The name of the zone
op	(I) The comparator. Can be either: RDV_above RDV_below RDV_intersects RDV_within RDV_outside RDV_interferes
scNamedZoneObjTag	(O) The resulting search criteria object. The object will not be persistently saved until you call AOM_save().

RDV_API int RDV_namedzone_srch_crt_get_attrs	(	tag_t	scNamedZoneObjTag,
		char **	name,
		int *	comparator
	)

This function is used for retrieving the name and operator from a Search Criteria Named Zone object.

Parameters

scNamedZoneObjTag	(I) The search criteria object
name	(OF) The name of the zone
comparator	(O) The comparator. Can be either: RDV_above RDV_below RDV_intersects RDV_within RDV_outside RDV_interferes

RDV_API int RDV_parseFile	(	char *	inputFile,
		char *	input,
		char ***	inputValueArray,
		int *	length
	)

This method parses the inputFile and returns the values of a particular column where column name is also input

Parameters

inputFile	(I)
input	(I)
inputValueArray	(OF) length
length	(O)

RDV_API int RDV_parseFileHeader	(	char *	inputFile,
		char ***	sub_tokens,
		int *	length
	)

This method parses the input file and returns the FileHeader as tokens.

Parameters

inputFile	(I)
sub_tokens	(O)
length	(O)

RDV_API int RDV_planezone_srch_crt_create	(	tag_t	typeTag,
		int	noOfCoordinates,
		const double *	coordinates,
		int	op,
		tag_t *	scPlaneZoneObjTag
	)

This function is used for creating a Search Criteria Plane Zone Filter object. It takes in the coordinates of the box and the operator value and returns the tag of the resulting Plane Zone Search Criteria object.

Parameters

typeTag	(I) The object type tag for the search criteria object. The type tag can be obtained by calling TCTYPE_find_type(), e.g. TCTYPE_find_type( "ApprSearchCriteriaPlaneZone", "ApprSearchCriteriaPlaneZone", &my_type_tag )
noOfCoordinates	(I) Expected to be 6
coordinates	(I) noOfCoordinates x,y,z coordinates of a point, and 3 coordinates for the normal vector
op	(I) The comparator. Can be either: RDV_above RDV_below RDV_intersects
scPlaneZoneObjTag	(O) The resulting search criteria object. The object will not be persistently saved until you call AOM_save().

RDV_API int RDV_planezone_srch_crt_get_attrs	(	tag_t	scPlaneZoneObjTag,
		int *	noOfCoordinates,
		double **	coordinates,
		int *	comparator
	)

This function is used for retrieving the coordinates and operator from a Search Criteria Plane Zone Search Criteria object.

Parameters

scPlaneZoneObjTag	(I) The search criteria object
noOfCoordinates	(O) Expected to be 6
coordinates	(OF) noOfCoordinates x,y,z coordinates of a point, and 3 coordinates for the normal vector
comparator	(O) The comparator. Can be either: RDV_above RDV_below RDV_intersects

RDV_API int RDV_prox_srch_crt_create	(	tag_t	typeTag,
		double	distance,
		tag_t	targetAppearance,
		tag_t	bgAppearance,
		tag_t *	scProximityObjTag
	)

This function is used for creating a Search Criteria Proximity object. It takes in tags of search criteria appearance objects that correspond to the selection states of the target and background appearances. It also takes in the proximity distance.

Parameters

typeTag	(I) The object type tag for the search criteria object. The type tag can be obtained by calling TCTYPE_find_type(), e.g. TCTYPE_find_type( "ApprSearchCriteriaProximity", "ApprSearchCriteriaProximity", &my_type_tag )
distance	(I) Search distance in units according to the top level assembly
targetAppearance	(I) The "ApprSearchCriteriaSlctState" object storing selected and non-selected target appearances
bgAppearance	(I) The "ApprSearchCriteriaSlctState" object storing selected and non-selected background appearances
scProximityObjTag	(O) The resulting search criteria object. The object will not be persistently saved until you call AOM_save().

RDV_API int RDV_prox_srch_crt_get_attrs	(	tag_t	scProximityObjTag,
		double *	distance,
		tag_t *	targetAppearance,
		tag_t *	bgAppearance
	)

This function is used for retrieving the distance and search criteria appearance tags, which represent the selection states of target and background appearances at the time of saving the Structure Context object.

Parameters

scProximityObjTag	(I) The search criteria object
distance	(O) The search distance
targetAppearance	(O) The "ApprSearchCriteriaSlctState" object storing selected and non-selected target appearances
bgAppearance	(O) The "ApprSearchCriteriaSlctState" object storing selected and non-selected background appearances

RDV_API int RDV_remove_designs_from_ia	(	tag_t	productItem,
		int	n_comps_to_be_cut,
		tag_t *	comps_to_be_cut
	)

Parameters

productItem	(I)
n_comps_to_be_cut	(I)
comps_to_be_cut	(I)

RDV_API int RDV_remove_parts_related_to_abe	(	tag_t	apn_tag,
		tag_t	topline
	)

Parameters

apn_tag	(I) > *
topline	(I) > *

RDV_API int RDV_replace_design_in_product	(	tag_t	component,
		logical	isUpdate,
		int	bomLine_count,
		tag_t *	bomLine_tags,
		int	prodRev_count,
		tag_t *	prodRev_tags,
		tag_t	archApn_tag,
		int	a_count,
		tag_t *	a_nves,
		int	b_count,
		tag_t *	b_nves,
		int	n_lou,
		tag_t *	lous
	)

Parameters

component	(I)
isUpdate	(I)
bomLine_count	(I)
bomLine_tags	(I)
prodRev_count	(I)
prodRev_tags	(I) prodRev_count
archApn_tag	(I)
a_count	(I)
a_nves	(I)
b_count	(I)
b_nves	(I)
n_lou	(I)
lous	(I)

RDV_API int RDV_replace_ind_design_in_product	(	tag_t	component,
		tag_t	bomLine,
		int	prodRev_count,
		tag_t *	prodRev_tags,
		tag_t	arch_element_apn,
		int	a_count,
		tag_t *	a_nves,
		int	b_count,
		tag_t *	b_nves,
		int	n_lous,
		tag_t *	lous
	)

Parameters

component	(I)
bomLine	(I)
prodRev_count	(I)
prodRev_tags	(I)
arch_element_apn	(I)
a_count	(I)
a_nves	(I)
b_count	(I)
b_nves	(I)
n_lous	(I)
lous	(I)

RDV_API int RDV_replace_part_in_product	(	tag_t	component,
		tag_t	bomLine,
		tag_t	archApn_tag,
		int	a_count,
		tag_t *	a_nves,
		logical	splitAndClone,
		logical	carrySubstitutes
	)

Parameters

component	(I)
bomLine	(I)
archApn_tag	(I)
a_count	(I)
a_nves	(I)
splitAndClone	(I)
carrySubstitutes	(I)

RDV_API int RDV_replace_part_solution_in_product	(	tag_t	component,
		tag_t	bomLine,
		tag_t	abeAPN,
		int	n_authNVEs,
		tag_t *	authNVEs,
		logical	splitAndClone,
		logical	carrySubstitutes,
		int	quantity,
		int	n_noteTexts,
		char **	noteTypes,
		char **	noteTexts
	)

Parameters

component	(I)
bomLine	(I)
abeAPN	(I)
n_authNVEs	(I)
authNVEs	(I)
splitAndClone	(I)
carrySubstitutes	(I)
quantity	(I)
n_noteTexts	(I)
noteTypes	(I)
noteTexts	(I)

RDV_API int RDV_retrieve_trushape_operator_for_app_search ( char * op )

This method takes in a string operator and converts into a integer operator to be used by Trushape module.

Parameters

op (I)

RDV_API int RDV_savedqry_srch_crt_create	(	tag_t	typeTag,
		const char *	queryName,
		int	noOfInstances,
		const char **	entries,
		const char **	values,
		tag_t *	scSQObjTag
	)

This function is used for creating a Search Criteria Saved Query object. It takes in the entries and values of the Saved Query along with the Saved Query name and returns the tag of the resulting Saved Query Search Criteria object.

Parameters

typeTag	(I) The object type tag for the search criteria object. The type tag can be obtained by calling TCTYPE_find_type(), e.g. TCTYPE_find_type( "ApprSearchCriteriaSavedQry", "ApprSearchCriteriaSavedQry", &my_type_tag )
queryName	(I) The name of the saved query
noOfInstances	(I) The number of user entries for the saved query
entries	(I) noOfInstances The list of user entries for the saved query
values	(I) noOfInstances The required values for the saved query
scSQObjTag	(O) The resulting search criteria object. The object will not be persistently saved until you call AOM_save().

RDV_API int RDV_savedqry_srch_crt_get_attrs	(	tag_t	scSQObjTag,
		char **	sqName,
		int *	noOfEntries,
		char ***	entries,
		char ***	values
	)

This function is used for retrieving the Saved Query name and the user entries and values from a Saved Query Search Criteria object.

Parameters

scSQObjTag	(I) The search criteria object
sqName	(OF) The name of the saved query
noOfEntries	(O) The number of user entries for the saved query
entries	(OF) noOfEntries The list of user entries for the saved query
values	(OF) noOfEntries The required values for the saved query

RDV_API int RDV_search_engine_ask_id	(	RDV_search_engine_t	search_engine,
		RDV_search_engine_id_t *	id
	)

This call returns a reference to the RDV search engine ID. This ID can be used as input to Search Engine API calls, e.g. QPL API

Parameters

search_engine	(I)
id	(O) The identifier of the currently active search engine

RDV_API int RDV_set_ia_method ( RDV_is_ia_function_t method_name )

This call sets the method being used to check if a BOMline is an Installation Assembly BOMline. There are 3 standard methods provided. These methods can be configured using the PortalDesignContextIsInstallationAssemblyMethod preference:

transformsComponents. Returns the 1st BOMLine that has at least one occurrence below it not using the identity transformation matrix.
isPrecise. Returns the 1st BOMLine representing an ItemRevisoin with a precise BOMViewRevision.
hasIRType. Returns the 1st BOMLine representing an ItemRevision of the type specified in the preference PortalDesignContextIsInstallationAssemblyMethod.hasIRType.Type

Parameters

method_name (I) A pointer to the functions that is to be used to identify Installation Assemblies

RDV_API int RDV_set_option_values	(	char *	item_info,
		char *	option_name,
		char *	option_value,
		tag_t *	var_exp_block
	)

Creates a variant expression block.

In a non-MFK (Multifield key) environment, the parameter "item_info" contains the Item ID.
In an MFK environment, the parameter "item_info" contains the key of any item which uniquely identifies the Item.
The key is a delimited string which contains name/value pairs of Item attributes separated by the ',' character, usually of the form attr1=value1,attr2=value2.... etc, where attr1, attr2 are property internal names (e.g. "item_id=GMC00723,object_name=topitem,object_type=Item").
To include a delimiter character ( e.g. ',' '=') in a name or value, the character should be escaped with the '\' character. E.g.:
- if the item ID contains an equals sign (123=456), the key string would be: "item_id=123\=456,object_type=Document".
- if the item ID contains an comma (123,456), the keys tring would be: "item_id=123\,456,object_type=Document".
- if the item ID contains a backslash (123\456), the keystring would be: "item_id=123\\456,object_type=Document".

The function returns:

ITK_ok on success.
ITEM_multiple_items_returned, if multiple items are found with the value provided for the "item_info" parameter.
BOM_no_variant_name, if input parameter option_name is null.
BOM_invalid_tag, Invalid tag received by BOM Module.

Parameters

item_info	(I) Item key (in MFK enviroment) or Item ID
option_name	(I) Name of Option
option_value	(I) Value of Option
var_exp_block	(O) tag of Variant Expression Block

RDV_API int RDV_srch_crt_get_type	(	tag_t	scObjTag,
		char **	type
	)

This method returns the type of a Search Criteria object.

Parameters

scObjTag	(I) The tag of the search criteria instance
type	(OF) The type of the search criteria instance

RDV_API void RDV_string_tokenizer	(	char *	string,
		char	delimit,
		int *	count,
		char ***	t
	)

This method tokenises the String based on the delimeter supplied.This method parses the string character by character basis

Parameters

string	(I)
delimit	(I)
count	(O)
t	(OF) count

RDV_API int RDV_structurecontext_evaluate	(	tag_t	scoTag,
		int	mode,
		tag_t	bom_window,
		int *	n_target_bom_lines,
		tag_t **	target_bom_lines,
		int *	n_unconfigured_target_bomlines,
		tag_t **	unconfigured_target_bomlines,
		int *	n_unconfigurable_target_bom_lines,
		tag_t **	unconfigurable_target_bom_lines,
		int *	n_bg_bom_lines,
		tag_t **	bg_bom_lines,
		int *	n_unconfigured_bg_bomlines,
		tag_t **	unconfigured_bg_bomlines,
		int *	n_unconfigurable_bg_bom_lines,
		tag_t **	unconfigurable_bg_bom_lines
	)

This function takes the tag of a context object and returns bom lines, which match the search criteria present in the context object.

The mode parameter can take one of the following values:

RDV_return_old_search_results - The structure context will be returned according to the state it was saved
RDV_reevaluate_search_criteria - The structure context will be returned as a result of reevaluating the search criteria
RDV_reevaluate_search_criteria

The structure context will be returned as a result of reevaluating the search criteria. Newly added component instances will be considered when reevaluating the search criteria

Parameters

scoTag	(I) The structure context object
mode	(I) One of the following: RDV_return_old_search_results RDV_reevaluate_search_criteria RDV_reevaluate_search_criteria
bom_window	(I)
n_target_bom_lines	(O) Number of target bom lines
target_bom_lines	(OF) n_target_bom_lines Target bom lines
n_unconfigured_target_bomlines	(O) Number of target BOM lines, which don�t configure for the current effective date or variant rule.
unconfigured_target_bomlines	(OF) n_unconfigured_target_bomlines Target BOM lines corresponding to search results, which don�t configure for the current effective date or variant rule.
n_unconfigurable_target_bom_lines	(O) Number of target BOM lines for which no revision configures or for which other errors were encountered.
unconfigurable_target_bom_lines	(OF) n_unconfigurable_target_bom_lines Target BOM lines for which no revision configures or for which other errors were encountered. The BOM line on which the error was encountered is given. This may be the actual background BOM line or a parent.
n_bg_bom_lines	(O) Number of background bom lines
bg_bom_lines	(OF) n_bg_bom_lines Background bom lines
n_unconfigured_bg_bomlines	(O) Number of background BOM lines, which don�t configure for the current effective date or variant rule.
unconfigured_bg_bomlines	(OF) n_unconfigured_bg_bomlines Background BOM lines corresponding to search results, which don�t configure for the current effective date or variant rule.
n_unconfigurable_bg_bom_lines	(O) Number of background BOM lines for which no revision configures or for which other errors were encountered
unconfigurable_bg_bom_lines	(OF) n_unconfigurable_bg_bom_lines Background BOM lines for which no revision configures or for which other errors were encountered. The BOM line on which the error was encountered is given. This may be the actual background BOM line or a parent.

RDV_API int RDV_update_occurrences_with_vc_in_product	(	int	bomLine_count,
		tag_t *	bomLines,
		int	prodRev_count,
		tag_t *	prodRev_tags,
		tag_t	arch_element_apn,
		int	a_count,
		tag_t *	a_nves,
		int	b_count,
		tag_t *	b_nves,
		int	n_lous,
		tag_t *	lous
	)

Parameters

bomLine_count	(I)
bomLines	(I) bomLine_count
prodRev_count	(I)
prodRev_tags	(I) prodRev_count
arch_element_apn	(I)
a_count	(I)
a_nves	(I) a_count
b_count	(I)
b_nves	(I) b_count

RDV_API int RDV_variant_expression_as_text	(	tag_t	ve,
		char **	as_text
	)

Parameters

ve	(I)
as_text	(O)

RDV_API int RDV_vis_strct_cntxt_obj_remove_sco_contents ( tag_t structureContextObjectTag )

Parameters

structureContextObjectTag (I)

RDV_API int RDV_vissco_ask_contents	(	tag_t	visSCOTag,
		const char *	relationName,
		int	subType,
		int *	numOFObjects,
		tag_t **	objects
	)

RDV_API int RDV_vissco_remove_content	(	tag_t	visSCOTag,
		tag_t	comp
	)

RDV_API int WEB_RDV_create_scg	(	tag_t	product_rev_tag,
		tag_t	revision_rule,
		int	no_variant_opts,
		tag_t *	variant_option_tags,
		int *	variant_option_values,
		tag_t	saved_variant_rule_tag,
		int	no_workparts,
		tag_t *	workpart_tags,
		int	no_entries,
		const char **	entries,
		const char **	values,
		tag_t	saved_qry_tag,
		double	distance,
		int	sel_tgt_occ_chain_size,
		const char **	sel_tgt_occ_thread_chain,
		int	unsel_tgt_occ_chain_size,
		const char **	unsel_tgt_occ_thread_chain,
		int	sel_bk_occ_chain_size,
		const char **	sel_bk_occ_thread_chain,
		int	unsel_bk_occ_chain_size,
		const char **	unsel_bk_occ_thread_chain,
		logical	voo_enabled,
		logical	true_shape_enabled,
		int	no_note_type,
		char **	note_type_str,
		char **	occ_qry_opr,
		char **	occ_values,
		int	no_form_attr,
		char **	is_item_form_flag,
		char **	relation_type_names,
		char **	form_type_names,
		char **	form_logical_opr,
		char **	form_attr_name,
		char **	form_qry_opr,
		char **	form_string_val,
		int	box_zone_instances,
		tag_t *	box_zone_tags,
		char **	boxzone_comp,
		tag_t *	sc_filter_grp_tag
	)

Parameters

product_rev_tag	(I)
revision_rule	(I)
no_variant_opts	(I)
variant_option_tags	(I)
variant_option_values	(I)
saved_variant_rule_tag	(I)
no_workparts	(I)
workpart_tags	(I)
no_entries	(I)
entries	(I)
values	(I)
saved_qry_tag	(I)
distance	(I)
sel_tgt_occ_chain_size	(I)
sel_tgt_occ_thread_chain	(I)
unsel_tgt_occ_chain_size	(I)
unsel_tgt_occ_thread_chain	(I)
sel_bk_occ_chain_size	(I)
sel_bk_occ_thread_chain	(I)
unsel_bk_occ_chain_size	(I)
unsel_bk_occ_thread_chain	(I)
voo_enabled	(I)
true_shape_enabled	(I)
no_note_type	(I)
note_type_str	(I)
occ_qry_opr	(I)
occ_values	(I)
no_form_attr	(I)
is_item_form_flag	(I)
relation_type_names	(I)
form_type_names	(I)
form_logical_opr	(I)
form_attr_name	(I)
form_qry_opr	(I)
form_string_val	(I)
box_zone_instances	(I)
box_zone_tags	(I)
boxzone_comp	(I)
sc_filter_grp_tag	(O)

RDV_API int WEB_RDV_create_sco	(	char *	sco_type,
		char *	sco_name,
		char *	sco_desc,
		tag_t	product_rev_tag,
		tag_t	revision_rule,
		int	no_variant_opts,
		tag_t *	variant_option_tags,
		int *	variant_option_values,
		tag_t	saved_variant_rule_tag,
		int	no_workparts,
		tag_t *	workpart_tags,
		tag_t	tgt_saved_qry_tag,
		int	no_tgt_crt,
		const char **	tgt_entires_crt,
		const char **	tgt_values_crt,
		int	sel_tgt_occ_chain_size,
		const char **	sel_tgt_occ_thread_chain,
		int	unsel_tgt_occ_chain_size,
		const char **	unsel_tgt_occ_thread_chain,
		int	sel_bk_occ_chain_size,
		const char **	sel_bk_occ_thread_chain,
		int	unsel_bk_occ_chain_size,
		const char **	unsel_bk_occ_thread_chain,
		int	tgt_occ_chain_size,
		const char **	tgt_occ_thread_chain,
		int	bk_occ_chain_size,
		const char **	bk_occ_thread_chain,
		int	no_sc_filter_grp_tags,
		tag_t *	sc_filter_grp_tags,
		tag_t *	sco_tag
	)

Parameters

sco_type	(I)
sco_name	(I)
sco_desc	(I)
product_rev_tag	(I)
revision_rule	(I)
no_variant_opts	(I)
variant_option_tags	(I)
variant_option_values	(I)
saved_variant_rule_tag	(I)
no_workparts	(I)
workpart_tags	(I)
tgt_saved_qry_tag	(I)
no_tgt_crt	(I)
tgt_entires_crt	(I)
tgt_values_crt	(I)
sel_tgt_occ_chain_size	(I)
sel_tgt_occ_thread_chain	(I)
unsel_tgt_occ_chain_size	(I)
unsel_tgt_occ_thread_chain	(I)
sel_bk_occ_chain_size	(I)
sel_bk_occ_thread_chain	(I)
unsel_bk_occ_chain_size	(I)
unsel_bk_occ_thread_chain	(I)
tgt_occ_chain_size	(I)
tgt_occ_thread_chain	(I)
bk_occ_chain_size	(I)
bk_occ_thread_chain	(I)
no_sc_filter_grp_tags	(I)
sc_filter_grp_tags	(I)
sco_tag	(O)

RDV_API int WEB_RDV_create_VISSC	(	tag_t	item_rev_tag,
		tag_t	revision_rule,
		int	no_variant_opts,
		tag_t *	variant_option_tags,
		int *	variant_option_values,
		tag_t	saved_variant_rule_tag,
		int	occurrence_count,
		const char **	occurrence_string_array,
		char *	client_id,
		tag_t *	vscobj
	)

Parameters

revision_rule	(I)
no_variant_opts	(I)
variant_option_tags	(I)
variant_option_values	(I)
saved_variant_rule_tag	(I)
occurrence_count	(I)
occurrence_string_array	(I)
client_id	(I)
vscobj	(O)

RDV_API int WEB_RDV_decodeGetQPLScheme	(	char *	QPLItemID,
		int *	errorCodeStatus,
		int *	nMessages,
		char **	messageString,
		int *	nProximityInfo,
		char **	proximityInfoString,
		int *	nAttributes,
		char **	attributesString,
		int *	nZones,
		char **	zonesString
	)

Parameters

QPLItemID	(I)
errorCodeStatus	(O)
nMessages	(O)
messageString	(OF) nMessages
nProximityInfo	(O)
proximityInfoString	(OF) nProximityInfo
nAttributes	(O)
attributesString	(OF) nAttributes
nZones	(O)
zonesString	(OF) nZones

RDV_API int WEB_RDV_execute_cacheless_search	(	tag_t	product_tag,
		tag_t	revision_rule,
		int	no_variant_opts,
		tag_t *	variant_option_tags,
		int *	variant_option_values,
		tag_t	saved_variant_rule_tag,
		int	no_entries,
		char **	entries,
		char **	values,
		tag_t	saved_qry_tag,
		int	occ_types_size,
		char **	ignore_occ_types,
		double	distance,
		int	occ_chain_size,
		const char **	occ_thread_chain,
		logical	voo_enabled,
		logical	true_shape_enabled,
		int	no_note_type,
		char **	note_type_str,
		char **	occ_qry_opr,
		char **	occ_values,
		int	no_form_attr,
		char **	is_item_form_flag,
		char **	relation_type_names,
		char **	form_type_names,
		char **	form_attr_name,
		char **	form_qry_opr,
		char **	form_bool_val,
		char **	form_int_val,
		char **	form_double_val,
		char **	form_string_val,
		char **	form_date_val,
		char **	form_uid_val,
		int	no_class_attr,
		char **	class_names,
		int *	class_attr_ids,
		char **	class_attr_values,
		logical	larger_than,
		double	diagonal_length,
		int	box_zone_instances,
		tag_t *	box_zone_tags,
		char **	boxzone_comp,
		int *	target_size,
		char ***	bom_line_prop,
		char ***	ia_assembly,
		int *	unconfig_bom_line_size,
		char ***	unconfig_bom_line_prop,
		char ***	unconfig_ia_assembly
	)

Parameters

product_tag	(I)
revision_rule	(I)
no_variant_opts	(I)
variant_option_tags	(I)
variant_option_values	(I)
saved_variant_rule_tag	(I)
no_entries	(I)
entries	(I)
values	(I)
saved_qry_tag	(I)
occ_types_size	(I)
ignore_occ_types	(I)
distance	(I)
occ_chain_size	(I)
occ_thread_chain	(I)
voo_enabled	(I)
true_shape_enabled	(I)
no_note_type	(I)
note_type_str	(I)
occ_qry_opr	(I)
occ_values	(I)
no_form_attr	(I)
is_item_form_flag	(I)
relation_type_names	(I)
form_type_names	(I)
form_attr_name	(I)
form_qry_opr	(I)
form_bool_val	(I)
form_int_val	(I)
form_double_val	(I)
form_string_val	(I)
form_date_val	(I)
form_uid_val	(I)
no_class_attr	(I)
class_names	(I)
class_attr_ids	(I)
class_attr_values	(I)
larger_than	(I)
diagonal_length	(I)
box_zone_instances	(I)
box_zone_tags	(I)
boxzone_comp	(I)
target_size	(O)
bom_line_prop	(OF) target_size is the array size
ia_assembly	(OF) target_size for target bomlines
unconfig_bom_line_size	(O) unconfig_bom_line_size for unconfigured bomlines
unconfig_bom_line_prop	(OF) unconfig_bom_line_size for unconfigured bomlines
unconfig_ia_assembly	(OF) unconfig_bom_line_size for unconfigured installation assemblies

RDV_API int WEB_RDV_executeQPLFilter	(	char *	qplBuildID,
		char *	distance,
		char *	booleanOperator,
		int	attCount,
		char **	attNames,
		char **	attOps,
		char **	attValues,
		int	zoneAttrCount,
		char **	zoneAttrNames,
		char **	zoneAttrOps,
		int	occCount,
		char **	occTags,
		int *	occEntityHandleCount,
		char **	occEntityHandle
	)

Parameters

qplBuildID	(I)
distance	(I)
booleanOperator	(I)
attCount	(I)
attNames	(I)
attOps	(I)
attValues	(I)
zoneAttrCount	(I)
zoneAttrNames	(I)
zoneAttrOps	(I)
occCount	(I)
occTags	(I)
occEntityHandleCount	(O)
occEntityHandle	(OF) occEntityHandle

RDV_API int Web_rdv_get_rev_rule	(	char *	fileBuff,
		char **	revRulename
	)

Parameters

fileBuff	(I)
revRulename	(OF)

RDV_API int WEB_RDV_get_sco_info	(	tag_t	sco_tag,
		int	sco_evaluate_mode,
		tag_t *	sco_rev_rule,
		tag_t *	sco_variant_rule,
		tag_t *	sco_prod_rev,
		int *	work_parts_size,
		char ***	work_parts_uids,
		double *	sco_prox_dist,
		int *	sco_zones_size,
		char ***	sco_zones_comp,
		char ***	sco_zones_uids,
		int *	svd_qry_entries_size,
		char ***	qry_entries,
		char ***	qry_values,
		tag_t *	sco_svd_qry_tag,
		int *	occ_attr_size,
		char ***	sco_occ_attr_name,
		char ***	sco_occ_oper,
		char ***	sco_occ_attr_value,
		int *	no_form_attr,
		char ***	sco_is_item_form_flag,
		char ***	sco_relation_type_names,
		char ***	sco_form_logical_opr,
		char ***	sco_form_type_names,
		char ***	sco_form_attr_name,
		char ***	sco_form_qry_opr,
		char ***	sco_form_string_val,
		logical *	sco_true_shape_enabled,
		logical *	sco_voo_enabled,
		logical *	sco_append_parts,
		int *	sco_target_lines_size,
		char ***	sco_target_lines_occ_chain,
		char ***	target_lines_ia,
		int *	sco_selected_target_lines_size,
		char ***	sco_selected_target_lines_props,
		int *	sco_backgrnd_lines_size,
		char ***	sco_backgrnd_lines_occ_chain,
		char ***	backgrnd_lines_ia,
		int *	sco_selected_backgrnd_lines_size,
		char ***	sco_selected_backgrnd_lines_props
	)

RDV_API int WEB_RDV_getExecuteQPLFilterCount	(	char *	qplBuildID,
		char *	distance,
		char *	booleanOperator,
		int	attCount,
		char **	attNames,
		char **	attOps,
		char **	attValues,
		int	zoneAttrCount,
		char **	zoneAttrNames,
		char **	zoneAttrOps,
		int	occCount,
		char **	occTags,
		int *	occEntityHandleCount,
		char **	occEntityHandle
	)

Parameters

qplBuildID	(I)
distance	(I)
booleanOperator	(I)
attCount	(I)
attNames	(I)
attOps	(I)
attValues	(I)
zoneAttrCount	(I)
zoneAttrNames	(I)
zoneAttrOps	(I)
occCount	(I)
occTags	(I)
occEntityHandleCount	(O)
occEntityHandle	(OF) occEntityHandle

RDV_API int WEB_RDV_getQPLBuilds	(	char **	QPLBuildsBuffer,
		char **	productIds
	)

Parameters

QPLBuildsBuffer	(OF) qpl_buffer
productIds	(OF) product_id

Modules

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation