Data Structures
struct	CBAEXT_act_line_to_bomline_s

struct	CBAEXT_cad_occurrence_info_s

struct	CBAEXT_cad_occurrence_solution_information_s

struct	CBAEXT_design_info_s

struct	CBAEXT_design_occurrence_act_line_info_s

struct	CBAEXT_design_occurrence_solution_info_s

struct	CBAEXT_design_to_part_information_s

struct	CBAEXT_item_revision_info_s

struct	CBAEXT_item_revision_part_info_s

struct	CBAEXT_item_revision_primary_publish_info_s

struct	CBAEXT_item_revision_to_part_info_s

struct	CBAEXT_part_info_s

struct	CBAEXT_part_to_item_revision_info_s

struct	CBAEXT_related_object_info_s

struct	CBAEXT_set_of_aligned_act_lines_s

struct	CBAEXT_solution_information_s

Typedefs
typedef struct CBAEXT_act_line_to_bomline_s	CBAEXT_act_line_to_bomline_t

typedef struct CBAEXT_cad_occurrence_info_s	CBAEXT_cad_occurrence_info_t

typedef struct CBAEXT_cad_occurrence_solution_information_s	CBAEXT_cad_occurrence_solution_infomation_t

typedef struct CBAEXT_design_info_s	CBAEXT_design_info_t

typedef struct CBAEXT_design_occurrence_act_line_info_s	CBAEXT_design_occurrence_act_line_info_t

typedef struct CBAEXT_design_occurrence_solution_info_s	CBAEXT_design_occurrence_solution_info_t

typedef struct CBAEXT_design_to_part_information_s	CBAEXT_design_to_part_information_t

typedef struct CBAEXT_item_revision_info_s	CBAEXT_item_revision_info_t

typedef struct CBAEXT_item_revision_part_info_s	CBAEXT_item_revision_part_info_t

typedef struct CBAEXT_item_revision_primary_publish_info_s	CBAEXT_item_revision_primary_publish_info_t

typedef struct CBAEXT_item_revision_to_part_info_s	CBAEXT_item_revision_to_part_info_t

typedef struct CBAEXT_part_info_s	CBAEXT_part_info_t

typedef struct CBAEXT_part_to_item_revision_info_s	CBAEXT_part_to_item_revision_info_t

typedef struct CBAEXT_related_object_info_s	CBAEXT_related_object_info_t

typedef struct CBAEXT_set_of_aligned_act_lines_s	CBAEXT_set_of_aligned_act_lines_t

typedef struct CBAEXT_solution_information_s	CBAEXT_solution_information_t

CBAEXT Setup Functions
CBAEXT_API int	CBAEXT_init_module (void)

CBAEXT Utility Functions
CBAEXT_API int	CBAEXT_is_cba_enabled (logical *is_enabled)

CBAEXT Alignment Functions
CBAEXT_API int	CBAEXT_align_item_revisions_and_parts (const int n_links, CBAEXT_item_revision_part_info_t alignment_info, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_align_item_revisions_and_parts_eco (int n_links, const CBAEXT_design_to_part_information_t alignment_info, const char eco, logical auto_commit, int return_part_count, tag_t return_part_tag, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_unalign_item_revisions_and_parts (const int n_links, CBAEXT_item_revision_part_info_t alignment_info, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_unalign_item_revisions_and_parts_eco (int n_links, const CBAEXT_design_to_part_information_t alignment_info, const char eco, logical auto_commit, int return_part_count, tag_t return_part_tag, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_publish_item_revisions (const int n_item_revs, CBAEXT_item_revision_info_t publish_info, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_set_default_cad_representations_for_parts (const int n_item_revs, CBAEXT_item_revision_part_info_t make_primary_info, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_set_default_cad_representations_for_parts_eco (int n_links, const CBAEXT_design_to_part_information_t alignment_info, const char eco, logical auto_commit, int return_part_count, tag_t return_part_tag, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_link_cad_occs_and_solutions_eco (int n_cad_occ, const CBAEXT_cad_occurrence_solution_infomation_t alignment_info, const char eco, logical auto_commit, int return_solution_count, tag_t return_solution_tag, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_unlink_cad_occs_and_solutions_eco (int n_cad_occ, const CBAEXT_cad_occurrence_solution_infomation_t alignment_info, const char eco, logical auto_commit, int return_solution_count, tag_t return_solution_tag, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_publish_cad_occurrences (const int n_cad_occ, const CBAEXT_cad_occurrence_info_t publish_info, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_link_design_occ_to_act_line (int n_des_occ, tag_t design_occs, int n_act_line, tag_t act_lines)

CBAEXT_API int	CBAEXT_unalign_design_occs_to_act_lines (int n_des_occ, tag_t design_occs, int n_act_line, tag_t act_lines)

CBAEXT_API int	CBAEXT_link_set_of_design_occ_and_act_line (int n_design_occ, const CBAEXT_design_occurrence_act_line_info_t alignment_info, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_unalign_set_of_design_occ_and_act_line (int n_design_occ, const CBAEXT_design_occurrence_act_line_info_t alignment_info, int error_count, PMM_error_store_map_t **error_map)

CBAEXT Query Functions
CBAEXT_API int	CBAEXT_find_aligned_act_lines_for_bomlines (const int n_des_occ, const tag_t design_occs, const char effective_date, int n_set_of_actlines, CBAEXT_set_of_aligned_act_lines_t *set_of_actlines)

CBAEXT_API int	CBAEXT_find_aligned_act_lines_for_designs (int n_des_occ, const tag_t design_occs, const char effective_date, const char effective_point, int n_set_of_actlines, CBAEXT_set_of_aligned_act_lines_t *set_of_actlines, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_find_aligned_act_lines_for_designs_with_stream (int n_des_occ, const tag_t design_occs, const char effective_date, const char effective_point, const char db_query_stream, int n_set_of_actlines, CBAEXT_set_of_aligned_act_lines_t set_of_actlines, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_find_bomlines_for_act_lines (const int n_actlines, const tag_t actlines, CBAEXT_act_line_to_bomline_t *actline_to_bomline)

CBAEXT_API int	CBAEXT_design_expand_below_all_levels (tag_t line, int child_lines_count, tag_t *child_lines)

CBAEXT_API int	CBAEXT_find_item_revisions_linked_to_parts (const int n_parttags, const CBAEXT_part_info_t inp_part_info, CBAEXT_item_revision_to_part_info_t *item_info)

CBAEXT_API int	CBAEXT_find_drawing_revisions_linked_to_parts (const int n_parttags, const CBAEXT_part_info_t inp_part_info, CBAEXT_item_revision_to_part_info_t *drawing_info)

CBAEXT_API int	CBAEXT_find_parts_linked_to_item_revisions (const int n_itemtags, const tag_t item_tags, CBAEXT_part_to_item_revision_info_t *part_info)

CBAEXT_API int	CBAEXT_find_parts_linked_to_drawing_revisions (const int n_itemtags, const tag_t item_tags, CBAEXT_part_to_item_revision_info_t *part_info)

CBAEXT_API int	CBAEXT_find_solutions_linked_to_design_occurrences (int n_cad_occ, const CBAEXT_cad_occurrence_info_t cadocc_info, int n_solutions, CBAEXT_design_occurrence_solution_info_t *solution_output, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_find_design_occurrences_linked_to_solutions (const int n_solutions, const CBAEXT_solution_information_t solution_info, int n_cad_occs, CBAEXT_design_occurrence_solution_info_t *solution_output, int error_count, PMM_error_store_map_t **error_map)

CBAEXT_API int	CBAEXT_ask_primary_representations (int n_parts, const CBAEXT_part_info_t part_info, CBAEXT_item_revision_part_info_t output, PMM_error_store_map_t *error_map)

Detailed Description

This module provides implementation for all the ITKs to be used by the customers of CAD BOM Alignment.

To use these ITK functions, include the cbaext.h file in the source code.

Typedef Documentation

typedef struct CBAEXT_act_line_to_bomline_s CBAEXT_act_line_to_bomline_t

The structure contains an Assembly Component Tree Line and the BOMLine that is aligned to it. This structure is returned by CBAEXT_find_bomlines_for_act_lines.

typedef struct CBAEXT_cad_occurrence_info_s CBAEXT_cad_occurrence_info_t

Contains a BOMLine and a client ID that is used to identify the BOMLines that fail the operation. This structure is passed as input to CBAEXT_publish_cad_occurrences and CBAEXT_find_solutions_linked_to_design_occurrences.

typedef struct CBAEXT_cad_occurrence_solution_information_s CBAEXT_cad_occurrence_solution_infomation_t

Encapsulates the data for a Solution and a BOMLine.

typedef struct CBAEXT_design_info_s CBAEXT_design_info_t

Contains a Item Revision and a client ID that is used to identify the Item Revision that fail the operation.

typedef struct CBAEXT_design_occurrence_act_line_info_s CBAEXT_design_occurrence_act_line_info_t

Encapsulates the data for a Solution and an ACTLine. This structure is passed as input to #CBAEXT_link_design_occ_to_act_line2 and #CBAEXT_unalign_design_occs_to_act_lines2.

typedef struct CBAEXT_design_occurrence_solution_info_s CBAEXT_design_occurrence_solution_info_t

Encapsulates the data for a Solution and a BOMLine. This structure is returned by #CBAEXT_find_cad_occurrences_linked_to_solutions and #CBAEXT_find_solutions_linked_to_cad_occurrences.

typedef struct CBAEXT_design_to_part_information_s CBAEXT_design_to_part_information_t

Contains a Part and the Item Revision tags that are aligned to this Part.

typedef struct CBAEXT_item_revision_info_s CBAEXT_item_revision_info_t

Contains an Item Revision and a client ID that is used to identify the Item Revisions that fail the operation. This structure is passed as input to CBAEXT_publish_item_revisions and #CBAEXT_find_solutions_linked_to_cad_occurrences.

typedef struct CBAEXT_item_revision_part_info_s CBAEXT_item_revision_part_info_t

Contains an Item Revision and a Part that are to be aligned or unaligned. This structure is passed as input to CBAEXT_align_item_revisions_and_parts and CBAEXT_unalign_item_revisions_and_parts.

typedef struct CBAEXT_item_revision_primary_publish_info_s CBAEXT_item_revision_primary_publish_info_t

Contains a Part and the Item Revision tags that are aligned to this Part. This structure is returned by CBAEXT_find_item_revisions_linked_to_parts and CBAEXT_find_drawing_revisions_linked_to_parts.

typedef struct CBAEXT_item_revision_to_part_info_s CBAEXT_item_revision_to_part_info_t

Contains a Part and the Item Revision tags that are aligned to this Part. This structure is returned by CBAEXT_find_item_revisions_linked_to_parts and CBAEXT_find_drawing_revisions_linked_to_parts.

typedef struct CBAEXT_part_info_s CBAEXT_part_info_t

Contains a Part for which the primary representation needs to be found. This structure is passed as input to CBAEXT_ask_primary_representations.

typedef struct CBAEXT_part_to_item_revision_info_s CBAEXT_part_to_item_revision_info_t

Contains an Item Revision and the Part tags that are aligned to this Item Revision. This structure is returned by CBAEXT_find_parts_linked_to_item_revisions and CBAEXT_find_parts_linked_to_drawing_revisions.

typedef struct CBAEXT_related_object_info_s CBAEXT_related_object_info_t

Contains the Name-value pair for property

typedef struct CBAEXT_set_of_aligned_act_lines_s CBAEXT_set_of_aligned_act_lines_t

Contains a set of aligned Assembly Component Tree Lines. This structure is returned by CBAEXT_find_aligned_act_lines_for_bomlines.

typedef struct CBAEXT_solution_information_s CBAEXT_solution_information_t

Encapsulates the data that defines a Solution. This structure is used to pass in the input for CBAEXT_find_design_occurrences_linked_to_solutions.

Function Documentation

CBAEXT_API int CBAEXT_align_item_revisions_and_parts	(	const int	n_links,
		CBAEXT_item_revision_part_info_t *	alignment_info,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Aligns CAD/Drawing Item Revisions to Parts in Usage Server. The input should be a homogeneous set of CAD Revisions or Drawing Revisions. An error is returned if both CAD and Drawing Revisions are passed as input during a single invocation of the method.

Returns

ITK_ok on success
PMM_mismatch_of_item_rev_and_part if the input contains a mixture of Item Revisions and Drawing Revisions.
PMM_null_consistency_stamp if the consistency stamp is not defined on the input Part.

Parameters

n_links	(I) Number of CAD/Drawing item revisions to align
alignment_info	(I) List of CAD/Drawing item revisions and PMM parts to be aligned
error_count	(O) Number of errors in the operation
error_map	(OF) error_count List of structures containing error details

CBAEXT_API int CBAEXT_align_item_revisions_and_parts_eco	(	int	n_links,
		const CBAEXT_design_to_part_information_t *	alignment_info,
		const char *	eco,
		logical	auto_commit,
		int *	return_part_count,
		tag_t **	return_part_tag,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Aligns CAD/Drawing Item Revisions to Parts in Usage Server. The input should be a homogeneous set of CAD Revisions or Drawing Revisions and Engineering Change Order information. An error is returned if both CAD and Drawing Revisions are passed as input during a single invocation of the method.

Returns

ITK_ok on success
#USAGEWC_mismatch_of_item_rev_and_part if the input contains a mixture of Item Revisions and Drawing Revisions.
#USAGEWC_null_consistency_stamp if the consistency stamp is not defined on the input Part.

Parameters

n_links	(I) number of Parts to align
alignment_info	(I) list of Designs and Part to align
eco	(I) ECO information for alignment
auto_commit	(I) Auto commit flag for alignment
return_part_count	(O) number of Parts returned after alignment
return_part_tag	(OF) Part tag response after alignment
error_count	(O) number of errors in the operation
error_map	(OF) list of structures containing error details

CBAEXT_API int CBAEXT_ask_primary_representations	(	int	n_parts,
		const CBAEXT_part_info_t *	part_info,
		CBAEXT_item_revision_part_info_t **	output,
		PMM_error_store_map_t **	error_map
	)

Finds the primary representations for the input Parts.

Returns

ITK_ok on success.
If an item revision which is the primary representation is found for a part, the item revision tag is populated in the output and the return code ITK_ok is added to the error_map parameter.
PMM_mandatory_fields_not_specified if the input parameter n_parts is less than or equal to zero or part_info is NULL.
PMM_no_primary_representation_found if no primary representation is found for at least one of the Corporate Parts. The value PMM_no_primary_representation_found is then added to the error_map parameters for the failing parts.
The default primary representation on a part can be set using the ITK CBAEXT_set_default_cad_representations_for_parts.
PMM_internal_error if an invalid part tag is processed.

Parameters

n_parts	(I) Number of parts for which the primary representation needs to be found
part_info	(I) List of parts for which the primary representation needs to be found
output	(OF)n_parts List of structures containing part and the aligned Item Revision. If no representation is found for a given part, the associated entry in the list will be a null pointer
error_map	(OF)n_parts List of structures containing error details. If no error has occurred for a given part, the associated entry in the list will be populated with clientId and ifail with ITK_ok. If an error has occurred for a given part, the associated entry in the list will be pointer to a PMM_error_store_map_t structure that contains more details.

CBAEXT_API int CBAEXT_design_expand_below_all_levels	(	tag_t	line,
		int *	child_lines_count,
		tag_t **	child_lines
	)

Expands the CAD structure that is below the input BOMLine to all lower levels.

Returns

ITK_ok on success
BOB_internal_error if the operation failed to expand the CAD structure.

Parameters

line	(I) Tag for the top line
child_lines_count	(O) Total number of children
child_lines	(OF) childLinesCount Child design lines tag

CBAEXT_API int CBAEXT_find_aligned_act_lines_for_bomlines	(	const int	n_des_occ,
		const tag_t *	design_occs,
		const char *	effective_date,
		int *	n_set_of_actlines,
		CBAEXT_set_of_aligned_act_lines_t **	set_of_actlines
	)

Deprecated:: This function is deprecated and will be removed from Tc12.1. In Tc10.1 onwards, please use CBAEXT_find_aligned_act_lines_for_designs

Finds aligned Assembly Component Tree (ACT) Lines in Usage Server for the given CAD Design Occurrences. A design occurrence (BOM line) may have alignment to multiple ACT Lines.

Returns

ITK_ok on success
PMM_act_no_alignedcad if no ACT Line is aligned to the input design occurrence.

Parameters

n_des_occ	(I) Number of design occurrences
design_occs	(I) List of design occurrences
effective_date	(I) Effective date for the aligned assembly component tree
n_set_of_actlines	(O) Number of sets of ACT lines
set_of_actlines	(OF) n_set_of_actlines Set of ACTLine lists that are aligned to each input BOMLine

CBAEXT_API int CBAEXT_find_aligned_act_lines_for_designs	(	int	n_des_occ,
		const tag_t *	design_occs,
		const char *	effective_date,
		const char *	effective_point,
		int *	n_set_of_actlines,
		CBAEXT_set_of_aligned_act_lines_t **	set_of_actlines,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

=============

!!!CAUTION!!!

Use CBAEXT_find_aligned_act_lines_for_designs_with_stream instead which which takes the effective stream as an input(Engineering/Prototype/virtual) to find the aligned ACTLines for the BOMLine Objects .

Deprecated:: This function is deprecated and will be removed from Tc12.1.
From Tc10.1.5 onwards, please use CBAEXT_find_aligned_act_lines_for_designs_with_stream

Finds aligned Assembly Component Tree (ACT) Lines in Usage Server for the given CAD Design Occurrences. A design occurrence (BOM line) may have alignment to multiple ACT Lines.

Returns

ITK_ok on success
PMM_act_no_alignedcad if no ACT Line is aligned to the input design occurrence.

Parameters

n_des_occ	(I) Number of design occurrences
design_occs	(I) List of design occurrences
effective_date	(I) Effective date for the aligned assembly component tree
effective_point	(I) effective point for the aligned assembly component tree
n_set_of_actlines	(O) Number of sets of ACT lines
set_of_actlines	(OF) n_set_of_actlines Set of ACTLine lists that are aligned to each input BOMLine
error_count	(O) number of errors in the operation
error_map	(OF) list of structures containing error details

CBAEXT_API int CBAEXT_find_aligned_act_lines_for_designs_with_stream	(	int	n_des_occ,
		const tag_t *	design_occs,
		const char *	effective_date,
		const char *	effective_point,
		const char *	db_query_stream,
		int *	n_set_of_actlines,
		CBAEXT_set_of_aligned_act_lines_t **	set_of_actlines,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Finds the aligned Assembly Component Tree (ACT) Lines in Usage Server for the given CAD Design Occurrences with effectivity stream criteria.
A design occurrence (BOMLine) may have alignment to multiple ACT Lines.

Returns

ITK_ok on success
PMM_find_aligned_act_for_cad_failed if no ACT Line is aligned to the input design occurrence.
PMM_effectivity_point_date_not_specified if effective_date or effective_point is not specified.
PMM_empty_design_object_information if design_occs list is empty or contain invalid tags.
PMM_effectivity_stream_not_specified if db_query_stream is not specified.

Parameters

n_des_occ	(I) Number of Design Occurrences
design_occs	(I) List of Design Occurrences
effective_date	(I) Effective date for the aligned assembly component tree
effective_point	(I) Effective point for the aligned assembly component tree
db_query_stream	(I) Effective stream for the aligned assembly component tree
n_set_of_actlines	(O) Number of sets of ACT lines
set_of_actlines	(OF) n_set_of_actlines Set of ACTLine lists that are aligned to each input BOMLine
error_count	(O) Number of errors in the operation
error_map	(OF) error_count List of structures containing error details

CBAEXT_API int CBAEXT_find_bomlines_for_act_lines	(	const int	n_actlines,
		const tag_t *	actlines,
		CBAEXT_act_line_to_bomline_t **	actline_to_bomline
	)

Finds BomLines that are aligned to the given ACTLines.

Returns

ITK_ok on success
PMM_act_no_alignedcad if no ACT Line is aligned to the input design occurrence.

Parameters

n_actlines	(I) Number of ACTLines
actlines	(I) List of ACTLines
actline_to_bomline	(OF) n_actlines List of aligned BOMLines and ACTLines

CBAEXT_API int CBAEXT_find_design_occurrences_linked_to_solutions	(	const int	n_solutions,
		const CBAEXT_solution_information_t *	solution_info,
		int *	n_cad_occs,
		CBAEXT_design_occurrence_solution_info_t **	solution_output,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Finds Solutions by selecting CAD occurrences.

Returns

ITK_ok on success
PMM_remote_alignedcad if the aligned cad occurrence belongs to a different Teamcenter site.
PMM_invalid_object if an invalid tag is input.

Parameters

n_solutions	(I) Number of Solutions
solution_info	(I) List of Solutions
n_cad_occs	(O) Number Of CAD occurrences
solution_output	(OF) n_cad_occs List of structures containing the Solution and the aligned CAD occurrence
error_count	(O) number of errors in the operation
error_map	(OF) list of structures containing error details

CBAEXT_API int CBAEXT_find_drawing_revisions_linked_to_parts	(	const int	n_parttags,
		const CBAEXT_part_info_t *	inp_part_info,
		CBAEXT_item_revision_to_part_info_t **	drawing_info
	)

Finds the Drawing Revisions that are aligned to the input Parts.

Returns

ITK_ok on success
PMM_invalid_object if an invalid part tag is input.

Parameters

n_parttags	(I) Number of Parts
inp_part_info	(I) List of Parts tags
drawing_info	(OF) n_parttags List of structures containing Part tag and the aligned Drawing Revision tags

CBAEXT_API int CBAEXT_find_item_revisions_linked_to_parts	(	const int	n_parttags,
		const CBAEXT_part_info_t *	inp_part_info,
		CBAEXT_item_revision_to_part_info_t **	item_info
	)

Finds the Item Revisions that are aligned to the input Parts.

Returns

ITK_ok on success
PMM_invalid_object if an invalid part tag is input.

Parameters

n_parttags	(I) Number of Parts
inp_part_info	(I) List of Parts tags
item_info	(OF) n_parttags List of structures containing Part tag and the aligned Item Revision tags

CBAEXT_API int CBAEXT_find_parts_linked_to_drawing_revisions	(	const int	n_itemtags,
		const tag_t *	item_tags,
		CBAEXT_part_to_item_revision_info_t **	part_info
	)

Finds the Parts that are aligned to the input Drawing Revisions.

Returns

ITK_ok on success
PMM_invalid_object if an invalid item revision tag is input.

Parameters

n_itemtags	(I) Number of Drawing Revisions
item_tags	(I) List of Drawing Revision tags
part_info	(OF) n_itemtags List of structures containing the Drawing Revision and the aligned Part tags

CBAEXT_API int CBAEXT_find_parts_linked_to_item_revisions	(	const int	n_itemtags,
		const tag_t *	item_tags,
		CBAEXT_part_to_item_revision_info_t **	part_info
	)

Finds the Parts that are aligned to the input CAD Item Revisions.

Returns

ITK_ok on success
PMM_invalid_object if an invalid item revision tag is input.

Parameters

n_itemtags	(I) Number of Item Revisions
item_tags	(I) List of Item Revision tags
part_info	(OF) n_itemtags List of structures containing the Item Revision tag and the aligned Part tags

CBAEXT_API int CBAEXT_find_solutions_linked_to_design_occurrences	(	int	n_cad_occ,
		const CBAEXT_cad_occurrence_info_t *	cadocc_info,
		int *	n_solutions,
		CBAEXT_design_occurrence_solution_info_t **	solution_output,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Finds Solutions by selecting design Occurrences.

Returns

ITK_ok on success
PMM_bomline_not_in_conext_of_ia if the input BOMLine is not part of an installation assembly.
BOM_line_null_pathnode if the Appearance Path Node could not be determined for the input BOMLine

Parameters

n_cad_occ	(I) Number of CAD occurrences
cadocc_info	(I) List of CAD occurrences
n_solutions	(O) Number of aligned Solutions
solution_output	(OF) n_solutions List of structures containing the CAD Occurrence and the aligned Solution
error_count	(O) number of errors in the operation
error_map	(OF) list of structures containing error details

CBAEXT_API int CBAEXT_init_module ( void )

Initializes the CBAEXT module. This function must be called before using any other CBAEXT module functions. This function will be called by the standard ITK startup code. The ITK programmer can ignore this function.

Note: A second call is ignored.

CBAEXT_API int CBAEXT_is_cba_enabled ( logical * is_enabled )

Indicates if the CAD BOM Alignment (CBA) module is configured to work with the Product Master Management (PMM) server.

Parameters

is_enabled (O) True if the CBA module is configured to work with the PMM server

CBAEXT_API int CBAEXT_link_cad_occs_and_solutions_eco	(	int	n_cad_occ,
		const CBAEXT_cad_occurrence_solution_infomation_t *	alignment_info,
		const char *	eco,
		logical	auto_commit,
		int *	return_solution_count,
		tag_t **	return_solution_tag,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Aligns CAD Occurrences to Solutions in Usage Server. The Solution is defined by providing a Line of Usage and a Sub-usage belonging to the Line of Usage. A Position Designator can be optionally provided, in which case the alignment is performed with the input Position Designator. If the Position Designator is not explicitly provided as input, the alignment is performed with the first available Position Designator belonging to the Line of Usage.

Returns

ITK_ok on success
#USAGEWC_cannot_align_a_topline if the top BOMLine from a CAD structure is selected for aligning to a Solution.
#USAGEWC_null_consistency_stamp if the consistency stamp is not defined on the input Line of Usage.
#USAGEWC_bomline_not_in_conext_of_ia if the input BOMLine is not part of an installation assembly.
BOM_line_null_pathnode if the Appearance Path Node could not be determined for the input BOMLine

Parameters

n_cad_occ	(I) number of CAD occurrences to align
alignment_info	(I) list of CAD occurrences and Solutions to align
eco	(I) ECO information for alignment
auto_commit	(I) Auto commit flag for alignment
return_solution_count	(O) number of Solution after alignment
return_solution_tag	(OF) Solution tag response after alignment
error_count	(O) number of errors in the operation
error_map	(OF) list of structures containing error details

CBAEXT_API int CBAEXT_link_design_occ_to_act_line	(	int	n_des_occ,
		tag_t *	design_occs,
		int	n_act_line,
		tag_t *	act_lines
	)

Deprecated:: This function is deprecated and will be removed from Tc12.1. In Tc10.1 onwards, please use #CBAEXT_link_design_occ_to_act_line2

Aligns CAD Design Occurrences to Assembly Component Tree (ACT) Lines in Usage Server.

Returns

ITK_ok on success
PMM_mismatch_of_selected_lines if the number of design occurrences and ACT Lines are different.
PMM_selected_lines_packed if the Assembly Component Tree Lines that are input are packed.
PMM_cannot_align_a_topline if the top BOMLine from a CAD structure is selected for aligning to a Solution.
PMM_bomline_not_in_conext_of_ia if the input BOMLine is not part of an installation assembly.
PMM_bomline_not_representation_of_act_topline if the Item Revision underlying the top BOMLine is not aligned to a Part.

Parameters

n_des_occ	(I) Number of design occurrences to align
design_occs	(I) List of design occurrences to align
n_act_line	(I) Number of Assembly Component Tree Lines to align
act_lines	(I) List of Assembly Component Tree Lines to align

CBAEXT_API int CBAEXT_link_set_of_design_occ_and_act_line	(	int	n_design_occ,
		const CBAEXT_design_occurrence_act_line_info_t *	alignment_info,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Aligns CAD Design Occurrences to Assembly Component Tree (ACT) Lines in Usage Server.

Returns

ITK_ok on success
PMM_mismatch_of_selected_lines if the number of design occurrences and ACT Lines are different.
PMM_selected_lines_packed if the Assembly Component Tree Lines that are input are packed.
PMM_cannot_align_a_topline if the top BOMLine from a CAD structure is selected for aligning to a Solution.
PMM_bomline_not_in_conext_of_ia if the input BOMLine is not part of an installation assembly.
PMM_bomline_not_representation_of_act_topline if the Item Revision underlying the top BOMLine is not aligned to a Part.

Parameters

n_design_occ	(I) Number of CAD occurrences to align
alignment_info	(I) List of CAD occurrences and Assembly Component Tree Lines to align
error_count	(O) Number of errors in the operation
error_map	(OF) error_count List of structures containing error details

CBAEXT_API int CBAEXT_publish_cad_occurrences	(	const int	n_cad_occ,
		const CBAEXT_cad_occurrence_info_t *	publish_info,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Publishes CAD occurrences to Usage Server.

Returns

ITK_ok on success
PMM_design_rev_has_no_rendering if the CAD Item Revision does not have a Rendering dataset attached to it.
PMM_assembly_with_embedded_jt if an assembly to be published contains a JT dataset in a non-leaf node.

Parameters

n_cad_occ	(I) Number of CAD occurrences to publish
publish_info	(I) List of CAD occurrences to publish
error_count	(O) Number of errors in the operation
error_map	(OF) error_count List of structures containing error details

CBAEXT_API int CBAEXT_publish_item_revisions	(	const int	n_item_revs,
		CBAEXT_item_revision_info_t *	publish_info,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Publishes CAD/Drawing Item Revisions to Usage Server. The input should be a homogeneous set of CAD Revisions or Drawing Revisions. An error is returned if both CAD and Drawing Revisions are passed as input during a single invocation of the method.

Returns

ITK_ok on success
PMM_mismatch_of_item_rev_and_part if the input contains a mixture of Item Revisions and Drawing Revisions.
PMM_design_rev_has_no_rendering if the CAD Item Revision does not have a Rendering dataset attached to it.
PMM_assembly_with_embedded_jt if an assembly to be published contains a JT dataset in a non-leaf node.
PMM_drawing_rev_has_no_specification_dataset if the Drawing Revision to be published does not have a Specification dataset attached to it.

Parameters

n_item_revs	(I) Number of CAD item revisions to publish
publish_info	(I) CAD Item Revision and client Id for each record
error_count	(O) Number of errors in the operation
error_map	(OF) error_count List of structures containing error details

CBAEXT_API int CBAEXT_set_default_cad_representations_for_parts	(	const int	n_item_revs,
		CBAEXT_item_revision_part_info_t *	make_primary_info,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Sets the default CAD representations for Parts in the Usage Server. The default representation will be displayed when the Part is visualized.

Returns

ITK_ok on success
PMM_design_rev_has_no_rendering if the CAD Item Revision does not have a Rendering dataset attached to it.
PMM_null_consistency_stamp if the consistency stamp is not defined on the input Part.

Parameters

n_item_revs	(I) Number of CAD item revisions
make_primary_info	(I) List of CAD item revisions and PMM parts for which the default representation is to be set
error_count	(O) Number of errors in the operation
error_map	(OF) error_count List of structures containing error details

CBAEXT_API int CBAEXT_set_default_cad_representations_for_parts_eco	(	int	n_links,
		const CBAEXT_design_to_part_information_t *	alignment_info,
		const char *	eco,
		logical	auto_commit,
		int *	return_part_count,
		tag_t **	return_part_tag,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Sets the default CAD representations for Parts in the Usage Server using eco. The default representation will be displayed when the Part is visualized.

Returns

ITK_ok on success
PMM_design_rev_has_no_rendering if the CAD Item Revision does not have a Rendering dataset attached to it.

Parameters

n_links	(I) number of records for make primary
alignment_info	(I) list of ItemRevision and Part for Make Primary
eco	(I) ECO information for Make Primary
auto_commit	(I) Auto commit flag for Make Primary
return_part_count	(O) number of Parts returned after Make Primary
return_part_tag	(OF) Part tag response after Make Primary
error_count	(O) number of errors in the operation
error_map	(OF) list of structures containing error details

CBAEXT_API int CBAEXT_unalign_design_occs_to_act_lines	(	int	n_des_occ,
		tag_t *	design_occs,
		int	n_act_line,
		tag_t *	act_lines
	)

Deprecated:: This function is deprecated and will be removed from Tc12.1. In Tc10.1 onwards, please use CBAEXT_unalign_design_occs_to_act_lines

Unaligns CAD occurrences from Assembly Component Tree Lines in Usage Server.

Returns

ITK_ok on success
PMM_mismatch_of_selected_lines if the number of design occurrences and ACT Lines are different.
PMM_selected_lines_packed if the Assembly Component Tree Lines that are input are packed.
PMM_bomline_not_in_conext_of_ia if the input BOMLine is not part of an installation assembly.

Parameters

n_des_occ	(I) Number of design occurrences to unalign
design_occs	(I) List of design occurrences to unalign
n_act_line	(I) Number of Assembly Component Tree Lines to unalign
act_lines	(I) List of Assembly Component Tree Lines to unalign

CBAEXT_API int CBAEXT_unalign_item_revisions_and_parts	(	const int	n_links,
		CBAEXT_item_revision_part_info_t *	alignment_info,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Unaligns CAD/Drawing Item Revisions from Parts in Usage Server. The input should be a homogeneous set of CAD Revisions or Drawing Revisions. An error is returned if both CAD and Drawing Revisions are passed as input during a single invocation of the method.

Returns

ITK_ok on success
PMM_mismatch_of_item_rev_and_part if the input contains a mixture of Item Revisions and Drawing Revisions.
PMM_null_consistency_stamp if the consistency stamp is not defined on the input Part.

Parameters

n_links	(I) Number of CAD/Drawing item revisions to unalign
alignment_info	(I) List of CAD/Drawing item revisions and PMM parts to be unaligned
error_count	(O) Number of errors in the operation
error_map	(OF) error_count List of structures containing error details

CBAEXT_API int CBAEXT_unalign_item_revisions_and_parts_eco	(	int	n_links,
		const CBAEXT_design_to_part_information_t *	alignment_info,
		const char *	eco,
		logical	auto_commit,
		int *	return_part_count,
		tag_t **	return_part_tag,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Unaligns CAD/Drawing Item Revisions from Parts in Usage Server. The input should be a homogeneous set of CAD Revisions or Drawing Revisions. An error is returned if both CAD and Drawing Revisions are passed as input during a single invocation of the method.

Returns

ITK_ok on success
#USAGEWC_mismatch_of_item_rev_and_part if the input contains a mixture of Item Revisions and Drawing Revisions.
#USAGEWC_null_consistency_stamp if the consistency stamp is not defined on the input Part.

Parameters

n_links	(I) number of Parts to align
alignment_info	(I) list of Designs and Part to align
eco	(I) ECO information for alignment
auto_commit	(I) Auto commit flag for alignment
return_part_count	(O) number of Parts returned after alignment
return_part_tag	(OF) Part tag response after alignment
error_count	(O) number of errors in the operation
error_map	(OF) list of structures containing error details

CBAEXT_API int CBAEXT_unalign_set_of_design_occ_and_act_line	(	int	n_design_occ,
		const CBAEXT_design_occurrence_act_line_info_t *	alignment_info,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Unaligns CAD occurrences from Assembly Component Tree Lines in Usage Server.

Returns

ITK_ok on success
PMM_mismatch_of_selected_lines if the number of design occurrences and ACT Lines are different.
PMM_selected_lines_packed if the Assembly Component Tree Lines that are input are packed.
PMM_bomline_not_in_conext_of_ia if the input BOMLine is not part of an installation assembly.

Parameters

n_design_occ	(I) Number of CAD occurrences to unalign
alignment_info	(I) List of CAD occurrences and Assembly Component Tree Lines to unalign
error_count	(O) Number of errors in the operation
error_map	(OF) error_count List of structures containing error details

CBAEXT_API int CBAEXT_unlink_cad_occs_and_solutions_eco	(	int	n_cad_occ,
		const CBAEXT_cad_occurrence_solution_infomation_t *	alignment_info,
		const char *	eco,
		logical	auto_commit,
		int *	return_solution_count,
		tag_t **	return_solution_tag,
		int *	error_count,
		PMM_error_store_map_t **	error_map
	)

Unaligns CAD Occurrences and Solutions in Usage Server. The Solution is defined by providing a Line of Usage, a Sub-usage belonging to the Line of Usage and a Position Designator also belonging to the Line of Usage.

Returns

ITK_ok on success
#USAGEWC_null_consistency_stamp if the consistency stamp is not defined on the input Line of Usage.
#USAGEWC_bomline_not_in_conext_of_ia if the input BOMLine is not part of an installation assembly.
BOM_line_null_pathnode if the Appearance Path Node could not be determined for the input BOMLine

Parameters

n_cad_occ	(I) number of CAD occurrences to align
alignment_info	(I) list of CAD occurrences and Solutions to align
eco	(I) ECO information for alignment
auto_commit	(I) Auto commit flag for alignment
return_solution_count	(O) number of Solution after alignment
return_solution_tag	(OF) Solution tag response after alignment
error_count	(O) number of errors in the operation
error_map	(OF) list of structures containing error details

Data Structures

Typedefs

CBAEXT Setup Functions

CBAEXT Utility Functions

CBAEXT Alignment Functions

CBAEXT Query Functions

Detailed Description

Typedef Documentation

Function Documentation

!!!CAUTION!!!