ITK Function Reference

(V10000.1.0.60_20160308.00)
Modules | Data Structures | Functions
Part and Manufacturing Information (PMI)

Modules

 Part and Manufacturing Information (PMI) Errors
 

Data Structures

struct  PMI0PMI_bomline_traversed_pmilookup_objs_s
 

Functions

PMI0PMI_API int PMI0PMI_user_filter_lines_for_pmilookup (int n_bomlines, const tag_t *bomlines, int *n_filtered_bomlines, tag_t **filtered_bomlines)
 
PMI0PMI_API int PMI0PMI_user_preferred_revisions_for_pmilookup (tag_t relation_type_tag, int n_bomlines, const PMI0PMI_bomline_traversed_pmilookup_objs_t *traversed_pmis, int *n_preferred_pmis, PMI0PMI_bomline_preferred_pmilookup_obj_t **preferred_pmis)
 
typedef struct
PMI0PMI_bomline_traversed_pmilookup_objs_s 
PMI0PMI_bomline_traversed_pmilookup_objs_t
 
typedef struct
PMI0PMI_bomline_preferred_pmilookup_obj_s 
PMI0PMI_bomline_preferred_pmilookup_obj_t
 

Detailed Description

This header contains the definition of user exits API that would be invoked during the PMI JT file lookup.

Typedef Documentation

Structure which holds information about the BOMLine and its preferred Part and Manufacturing Information (PMI) Item Revision. This structure is used in PMI0PMI_user_preferred_revisions_for_pmilookup as output.

Structure which holds information about the BOMLine for which the Part and Manufacturing Information (PMI) is looked for, the intermediate Item Revision at which the lookup traversal is at and the Part and Manufacturing Information (PMI) Item Revisions from which the preferred one needs to be selected. This structure is used in PMI0PMI_user_preferred_revisions_for_pmilookup as input which lists the Item Revisions for a given BOMLine from which the preferred Item Revision is to chosen.

Function Documentation

PMI0PMI_API int PMI0PMI_user_filter_lines_for_pmilookup ( int  n_bomlines,
const tag_t bomlines,
int *  n_filtered_bomlines,
tag_t **  filtered_bomlines 
)

Custom method with the given definition can be used to register as base behavior for BMF_PMI0_BOMLINE_filter_lines_for_pmilookup message. By registering and implementing base behavior, the business logic that is needed to filter the BOMLines on which the PMI lookup has to be performed can be acheived. If all BOMLines would not have PMI, then filtering them using this user exit will improve performance. Note: This is provided here so that it serves as API prototype reference for the implementer to implement Part and Manufacturing Information (PMI) lookup user exit.

An error ITK_invalid_name (26008) will be returned if the function that is to be invoked as user exit has an invalid name.

Parameters
n_bomlines(I) Number of BOMLines
bomlines(I) BOMLines on which to perform the PMI look
n_filtered_bomlines(O) Filter number of BOMLines to consider for PMI lookup
filtered_bomlines(OF) n_filtered_bomlines The array of BOMLines for which the PMI look need to be performed
PMI0PMI_API int PMI0PMI_user_preferred_revisions_for_pmilookup ( tag_t  relation_type_tag,
int  n_bomlines,
const PMI0PMI_bomline_traversed_pmilookup_objs_t traversed_pmis,
int *  n_preferred_pmis,
PMI0PMI_bomline_preferred_pmilookup_obj_t **  preferred_pmis 
)

Custom method with the given definition can be used to register as base behavior for BMF_PMI0_BOMLINE_preferred_revisions_for_pmilookup message. By registering and implementing base behavior, the business logic that is needed to select the preferred PMI when multiple PMI of same Item are associated with a Product can be achieved. Note: This is provided here so that it serves as API prototype reference for the implementer to implement Part and Manufacturing Information (PMI) lookup user exit.

An error ITK_invalid_name (26008) will be returned if the function that is to be invoked as user exit has an invalid name.

Parameters
relation_type_tag(I) Tag of the relation being traversed.
n_bomlines(I) Number of BOMLines
traversed_pmis(I) A list of structures that associates the bom line and the number of primary or secondary objects that were traversed during the PMI lookup
n_preferred_pmis(O) Number of bom lines for which the preferred PMIs was determined
preferred_pmis(OF) n_preferred_pmis An array of structures that associates the bom line and the preferred PMI