PMM

Modules
	PMM Errors

Data Structures
struct	PMM_actlines_per_child_s
struct	PMM_breakdown_output_s
struct	PMM_error_store_map_s
struct	PMM_level_to_actlines_with_details_s
struct	PMM_name_value_criteria_s

Typedefs
typedef struct PMM_actlines_per_child_s	PMM_actlines_per_child_t
typedef struct PMM_breakdown_output_s	PMM_breakdown_output_t
typedef struct CBA_API PMM_error_store_map_s	PMM_error_store_map_t
typedef struct PMM_level_to_actlines_with_details_s	PMM_level_to_actlines_with_details_t
typedef struct PMM_name_value_criteria_s	PMM_name_value_criteria_t

PMM Setup Functions
CBA_API int	PMM_init_module (void)
CBA_API int	PMM_exit_module (void)

PMM Utility Functions
CBA_API int	PMM_is_usage_enabled (logical *is_enabled)

PMM Query Functions
CBA_API int	PMM_complex_generic_query (char *class_name, char *where_clause, int num_return_attribute_names, char **return_attribute_names, int *num_found, tag_t **proxies)
CBA_API int	PMM_generic_query (const char *class_name, int num_criteria, char **criteria_names, char **criteria_values, tag_t usage_config_context, int num_return_attribute_names, char **return_attribute_names, int *num_found, tag_t **proxies)
CBA_API int	PMM_multi_break_down_query (PMM_name_value_criteria_t *source_part_criteria, PMM_name_value_criteria_t *query_criteria, bool with_details, int explosion_level, tag_t *proxy, PMM_breakdown_output_t *breakdown_output)
CBA_API int	PMM_update_ps_for_recipe (tag_t window_tag, int count, const tag_t *selected_bomlines)

PMM Structure Context Object Functions
CBA_API int	PMM_add_to_layout (tag_t *selected_lines, int count, tag_t layout_item_rev, const char *view_type_name, tag_t *layout_window, tag_t *layout_top_line, int *no_of_children, tag_t **layout_childlines, int *no_of_conflicts, tag_t **conflicting_lines)

Detailed Description

This module provides implementation for all the ITKs to be used by the customers of Product Master Management.

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

Typedef Documentation

typedef struct PMM_actlines_per_child_s PMM_actlines_per_child_t

Contains the Assembly Component Tree Lines in multilevel engineering breakdown structure.

typedef struct PMM_breakdown_output_s PMM_breakdown_output_t

Contains the Assembly Component Tree multilevel engineering breakdown structure.

typedef struct CBA_API PMM_error_store_map_s PMM_error_store_map_t

Contains the error details for a particular input that failed. If the input data structures contained a client ID, the client ID field will be populated with the client ID of the failing input.

typedef struct PMM_level_to_actlines_with_details_s PMM_level_to_actlines_with_details_t

Contains the levelwise Assembly Component Tree Lines in multilevel engineering breakdown structure.

typedef struct PMM_name_value_criteria_s PMM_name_value_criteria_t

Contains the query criteria for multilevel engineering breakdown

Function Documentation

CBA_API int PMM_add_to_layout	(	tag_t *	selected_lines,
		int	count,
		tag_t	layout_item_rev,
		const char *	view_type_name,
		tag_t *	layout_window,
		tag_t *	layout_top_line,
		int *	no_of_children,
		tag_t **	layout_childlines,
		int *	no_of_conflicts,
		tag_t **	conflicting_lines
	)

Creates a study like structure called Layout Structure by setting input Layout Item Revision as Top Line of the structure and adding given list of input BOMLines to it.

Returns

• ITK_ok on success
• PMM_empty_input_for_Add_to_Layout if a required input element is not specified.
• PMM_improper_precision_of_bvr_for_add_to_layout if input Item Revision already has a BOMView Revision which is of improper precision.

Parameters

selected_lines	(I) Input BOMLines.
count	(I) Number of Input BOMLines.
layout_item_rev	(I) Layout Item Revision.
view_type_name	(I) Type of BOM View to be used for Layout structure. To use default type of BOM View, null will be accepted here.
layout_window	(O) BOMWindow of Layout structure.
layout_top_line	(O) Top BOMLine of Layout structure.
no_of_children	(O) Number of Layout childlines.
layout_childlines	(OF) Layout childlines.
no_of_conflicts	(O) Number of Conflicting lines which are not added to Layout.
conflicting_lines	(OF) Conflicting lines which are not added to Layout.

CBA_API int PMM_complex_generic_query	(	char *	class_name,
		char *	where_clause,
		int	num_return_attribute_names,
		char **	return_attribute_names,
		int *	num_found,
		tag_t **	proxies
	)

Queries objects defined in the Product Master Management (PMM) database using the specified SQL where clause. Returns a list of Teamcenter proxy objects that represent the queried PMM objects.

Returns

• ITK_ok on success
• PMM_usage_server_error if an error has occurred in the PMM server.
• PMM_failed_to_login if the login to the PMM server has failed.

Parameters

class_name	(I) Name of the PMM class to which the objects belong
where_clause	(I) Where clause used to query the PMM objects
num_return_attribute_names	(I) Number of attributes to be returned by the query
return_attribute_names	(I) List of attributes to be returned by the query
num_found	(O) Number of objects found
proxies	(OF) num_found List of objects found

CBA_API int PMM_exit_module

(

void

)

Terminates the Product Master Management (PMM) module. The ITK programmer can ignore this function.

Note

A second call is ignored.

CBA_API int PMM_generic_query	(	const char *	class_name,
		int	num_criteria,
		char **	criteria_names,
		char **	criteria_values,
		tag_t	usage_config_context,
		int	num_return_attribute_names,
		char **	return_attribute_names,
		int *	num_found,
		tag_t **	proxies
	)

Queries objects defined in the Product Master Management (PMM) server using the specified query criteria. Returns a list of Teamcenter proxy objects that represent the queried PMM objects.

Returns

• ITK_ok on success
• PMM_usage_server_error if an error has occurred in the PMM server.
• PMM_failed_to_login if the login to the PMM server has failed.

Parameters

class_name	(I) Name of the PMM class to which the objects belong
num_criteria	(I) Number of criteria used for the query
criteria_names	(I) Names of the criteria used for the query
criteria_values	(I) Values of the criteria used for the query
usage_config_context	(I) Configuration Context used for the query
num_return_attribute_names	(I) Number of attributes to be returned by the query
return_attribute_names	(I) List of attributes to be returned by the query
num_found	(O) Number of objects found
proxies	(OF) num_found List of objects found

CBA_API int PMM_init_module

(

void

)

Initializes the Product Master Management (PMM) module. This function must be called before using any other PMM 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.

CBA_API int PMM_is_usage_enabled

(

logical *

is_enabled

)

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

Parameters

is_enabled

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

CBA_API int PMM_multi_break_down_query	(	PMM_name_value_criteria_t *	source_part_criteria,
		PMM_name_value_criteria_t *	query_criteria,
		bool	with_details,
		int	explosion_level,
		tag_t *	proxy,
		PMM_breakdown_output_t *	breakdown_output
	)

Executes multibreakdown query from the Product Master Management (PMM) server server against constructs represented by the query criteria's in TcServer and returns the top level assembly part.

Returns

• ITK_ok on success
• PMM_mandatory_fields_not_specified if a required input element is not specified.
• PMM_usage_server_error if an error has occurred in the PMM server.
• PMM_failed_to_login if the login to the PMM server has failed.
• PMM_part_breakdown_failed if the part breakdown operation has failed.

Parameters

source_part_criteria	(I) source part's criteria i.e Assembly Part on which the breakdown is performed
query_criteria	(I) query criteria's for line of assembly
with_details	(I) set the flag as true to populate the output structure "PMM_breakdown_output_t".
explosion_level	(I) The depth at which a component part is present with respect to the root assembly node.
proxy	(O) Assembly part proxy object of Line Of Assembly having depth of one in the breakdown structure
breakdown_output	(O) Structure having information like : For level x what is the Assembly part's ACTLine and its corresponding child ACTLines.

CBA_API int PMM_update_ps_for_recipe	(	tag_t	window_tag,
		int	count,
		const tag_t *	selected_bomlines
	)

Updates the content of a BOMWindow and some BOMLines, based on the bill of material data fetched from the Product Master Manager (PMM).

Note

If any error is returned (e.g. not all tags passed in as part of selected_bomlines are actually BOMLines, or a BOMLine update fails), all changes to the database are rolled back.

Returns

• ITK_ok on success
• PMM_usage_server_error if the PMM server reports an error.
• CXPOM_invalid_tag if window_tag is null or fails validation.
• PMM_failed_to_find_scope if one or more of the tags given in selected_bomlines is null or fails validation.
• PMM_failed_to_login if the login to the PMM server has failed.

Parameters

window_tag	(I) BOMWindow of Product structure.
count	(I) Number of Input BOMLines.
selected_bomlines	(I) Input BOMLines to be updated.