Modules
	ASBUILT Errors

Data Structures
struct	SearchInstallableAsbPhysPartParams

Typedefs
typedef struct ASBUILT_API SearchInstallableAsbPhysPartParams	SearchInstallableAsbPhysPartParams

Functions
ASBUILT_API int	ASBUILT_bom_compare (tag_t srcLines, int srcLineCount, tag_t tarLines, int tarLineCount, int options, tag_t assyCtxtLineTag, tag_t bomCtxtLineTag, int srcRetCount, tag_t srcRetTags, int matRetCount, tag_t **matRetTags)

ASBUILT_API int	ASBUILT_bom_compare_no_context (tag_t srcLine, tag_t tarLine, const char mode_name, int output_to, int srcRetCount, tag_t *srcRetTags, int matRetCount, tag_t *matRetTags, int reportLength, char ***report_lines)

ASBUILT_API int	ASBUILT_build_physical_part_revision (tag_t oldPhysPartRevTag, date_t effectiveFromDate, tag_t *outPhysPartRevTag)

ASBUILT_API int	ASBUILT_convert_uids_into_bom_lines (int count, const char bom_line_uids, tag_t bom_lines)

ASBUILT_API int	ASBUILT_convert_uids_into_bom_lines_with_flag (int count, const char bom_line_uids, logical show_untraced_parts, tag_t bom_lines)

ASBUILT_API int	ASBUILT_create_compare_desc ()

ASBUILT_API int	ASBUILT_create_missing_part_structure (tag_t selectedLineTag, tag_t *replacedLineTag)

ASBUILT_API int	ASBUILT_gen_phystruc (tag_t inLine, GenerateStructureParams inParam, tag_t phys_rev)

ASBUILT_API int	ASBUILT_generate_recipe (tag_t asbuilt_bom_line, char **recipe)

ASBUILT_API int	ASBUILT_get_all_open_usage (tag_t inLine, tag_t physicalPartRevision, logical allUsages, char *usageType, char openUsages, int count, tag_t **childBOMLine)

ASBUILT_API int	ASBUILT_get_all_open_usage_2 (tag_t parentPhysPart, tag_t physicalPartRevision, logical allUsages, char *usageType, char openUsages, int count, tag_t **childBOMLine)

ASBUILT_API int	ASBUILT_get_all_open_usages (tag_t inLine, tag_t physicalPartRevision, char **openUsages, int count, tag_t **childBOMLine)

ASBUILT_API int	ASBUILT_get_all_open_usages_2 (tag_t parentPhysPart, tag_t physicalPartRevision, char **openUsages, int count, tag_t **childBOMLine)

ASBUILT_API int	ASBUILT_init_module ()

ASBUILT_API int	ASBUILT_install_asbuilt_part_revision (tag_t inLine, tag_t physicalPartRevision, tag_t selectedBOMLineImpl, InstallPartParams inParams, tag_t asbuiltStructure, tag_t *installedLineTag)

ASBUILT_API int	ASBUILT_install_asbuilt_part_revision_2 (tag_t inLine, tag_t inParentPhysicalPartRev, tag_t physicalPartRevision, tag_t selectedBOMLineImpl, InstallPartParams inParams, tag_t asbuiltStructure, tag_t *installedLineTag)

ASBUILT_API int	ASBUILT_install_physical_part (tag_t inLine, tag_t physicalPartRevision, char usageType, tag_t selectedBOMLineImpl, InstallPartParams inParams, tag_t allowedDeviation, tag_t asbuiltStructure, tag_t *installedLineTag)

ASBUILT_API int	ASBUILT_install_physical_part_2 (tag_t inLine, tag_t inParentPhysicalPart, tag_t physicalPartRevision, char usageType, tag_t selectedBOMLineImpl, InstallPartParams inParams, tag_t allowedDeviation, tag_t asbuiltStructure, tag_t *installedLineTag)

ASBUILT_API int	ASBUILT_line_ask_all_child_lines (tag_t bom_line, int count, tag_t *children)

ASBUILT_API int	ASBUILT_line_set_window_top (tag_t window, tag_t physicalPart, tag_t physicalPartRevision, tag_t *topBOMLine)

ASBUILT_API int	ASBUILT_rebuild_asbuilt_structure (tag_t inLine, date_t rebuildDate, tag_t *newPhysPartRev)

ASBUILT_API int	ASBUILT_replace_physical_part (tag_t selectedAsbuiltBOMLline, tag_t copiedPhysPartRevision, InstallPartParams params, tag_t replacerAsbuiltBOMLine)

ASBUILT_API int	ASBUILT_search_installable_physical_part_revisions (tag_t selParentPhysBOMLine, tag_t selectedBOMLineImpl, int attrCount, char attributeNames, char attributeValues, SearchInstallableAsbPhysPartParams *outParams)

Detailed Description

The As-Built (AsBuilt) module implements the As-Built Structure management behaviour.

Typedef Documentation

typedef struct ASBUILT_API SearchInstallableAsbPhysPartParams SearchInstallableAsbPhysPartParams

Structure used search installable physical part revisions. This structure will be used to store all valid preferred, alternate, substitute and deviated physical part revision and each valid count.

Function Documentation

ASBUILT_API int ASBUILT_bom_compare	(	tag_t *	srcLines,
		int	srcLineCount,
		tag_t *	tarLines,
		int	tarLineCount,
		int	options,
		tag_t	assyCtxtLineTag,
		tag_t	bomCtxtLineTag,
		int *	srcRetCount,
		tag_t **	srcRetTags,
		int *	matRetCount,
		tag_t **	matRetTags
	)

ITK function for AsBuilt BOM Compare using AbsOcc ID

Parameters

srcLines	(I) List of lines from source window. Structures rooted by each of them will be checked.
srcLineCount	(I) Number of source lines.
tarLines	(I) List of lines from target widnow. Checked will be done over the structures under these lines only.
tarLineCount	(I) Number of target lines.
options	(I) Options of accountability check. Expected to be any combination of the following: add 1 - For source lines with "stop" marks, if to check their children. add 2 - If to check source lines at the lowest level only, as opposed to at all levels. add 4 - If to search all contextes in target, as opposed to the current active context. add 8 - If to search by absolute occurrence ID's only, as opposed to strictly by absolute occurrence objects. add 16 - If to compare a pre-define list of additional properties during the check. add 32 - If to search for target lines connected via PublishLink
assyCtxtLineTag	(I) Tag of context line
bomCtxtLineTag	(I) Tag of BOM Context Line
srcRetCount	(O) Number of source lines checked.
srcRetTags	(OF) List of source lines checked. If not interested in this output, let *srcRetCount = -1 before calling.
matRetCount	(O) Number of matched target lines
matRetTags	(OF) List of matched target lines. If not interested in this output, let *matRetCount = -1 before calling.

ASBUILT_API int ASBUILT_bom_compare_no_context	(	tag_t	srcLine,
		tag_t	tarLine,
		const char *	mode_name,
		int	output_to,
		int *	srcRetCount,
		tag_t **	srcRetTags,
		int *	matRetCount,
		tag_t **	matRetTags,
		int *	reportLength,
		char ***	report_lines
	)

ITK function for AsBuilt BOM Compare

Parameters

srcLine	(I) Tag of Source Line
tarLine	(I) Tag of Target Line
mode_name	(I) BOM Comapre Mode
output_to	(I) Output to
srcRetCount	(O) Number of source lines checked.
srcRetTags	(OF) List of source lines checked.
matRetCount	(O) Number of matched target lines
matRetTags	(OF) List of matched target lines.
reportLength	(O) Number of report lines
report_lines	(O) Report lines

ASBUILT_API int ASBUILT_build_physical_part_revision	(	tag_t	oldPhysPartRevTag,
		date_t	effectiveFromDate,
		tag_t *	outPhysPartRevTag
	)

ITK function to revise As-Built Physical Part Revision(O) Tag of new Physical Element Revision

Parameters

oldPhysPartRevTag	(I) Tag of Physical Part Revision to be revised
effectiveFromDate	(I) Effective From Date of new Revision

ASBUILT_API int ASBUILT_convert_uids_into_bom_lines	(	int	count,
		const char **	bom_line_uids,
		tag_t **	bom_lines
	)

Converts UIDs into the matching BOM Lines.

Note: If any error has occurred, a NULLTAG value will be provided for the matching offending UIDs.

Returns

ITK_ok on success
ASBUILT_invalid_uid if any input UID is invalid.
Possibly other errors

Parameters

count	(I) Number of UIDs.
bom_line_uids	(I) BOM Line UIDs
bom_lines	(OF) count The BOM Lines deducted from the provided UIDs. If an invalid UID is passed, the matching tag will be NULLTAG.

ASBUILT_API int ASBUILT_convert_uids_into_bom_lines_with_flag	(	int	count,
		const char **	bom_line_uids,
		logical	show_untraced_parts,
		tag_t **	bom_lines
	)

Converts UIDs into the matching BOM Lines with the untraced parts visibility on or off.

Note: If any error has occurred, a NULLTAG value will be provided for the matching offending UIDs.

Returns

ITK_ok on success
POM_invalid_tag if any input UID is invalid.
Possibly other errors

Parameters

count	(I) Number of UIDs.
bom_line_uids	(I) BOM Line UIDs
show_untraced_parts	(I) Untraced Parts Visibility
bom_lines	(OF) count The BOM Lines deducted from the provided UIDs. If a invalid UID is passed, the matching tag will be NULLTAG.

ASBUILT_API int ASBUILT_create_compare_desc ( )

ITK function to create compare descriptor for BOM Compare

ASBUILT_API int ASBUILT_create_missing_part_structure	(	tag_t	selectedLineTag,
		tag_t *	replacedLineTag
	)

ITK function to create missing part AsBuilt structure

Parameters

selectedLineTag	(I) Tag of selected AsBuilt BOM Line
replacedLineTag	(I) Tag of replaced AsBuilt BOM Line

ASBUILT_API int ASBUILT_gen_phystruc	(	tag_t	inLine,
		GenerateStructureParams *	inParam,
		tag_t *	phys_rev
	)

ITK function to generate AsBuilt Structure

Parameters

inLine	(I) Parent BOM line whose children are wanted
inParam	(I) Parent BOM line whose children are wanted
phys_rev	(O) count Returned lines

ASBUILT_API int ASBUILT_generate_recipe	(	tag_t	asbuilt_bom_line,
		char **	recipe
	)

Generates a recipe for an ASBUILT BOM Line.
A recipe provides the properties required to make a Permanent ID for a runtime object unique.

Returns

ITK_ok on success
CXPOM_invalid_tag if the BOM Line tag is invalid.
Possibly other errors

Parameters

asbuilt_bom_line	(I) Input ASBUILT BOM Line.
recipe	(OF) Recipe for input BOM Line.

ASBUILT_API int ASBUILT_get_all_open_usage	(	tag_t	inLine,
		tag_t	physicalPartRevision,
		logical	allUsages,
		char ***	usageType,
		char ***	openUsages,
		int *	count,
		tag_t **	childBOMLine
	)

DEPRECATED FUNCTION

ITK function to get all open usage values.

Deprecated:: This function is deprecated, it will be removed from Teamcenter 8.0.1. In its place use ASBUILT_get_all_open_usages

Parameters

inLine	(I) Selected AsBuiltBOMLine
physicalPartRevision	(I) Copied Physical Part Revision
allUsages	(I) Whether to fetch all the usages or preffered only
usageType	(I) Usage Type, Preferred , Other or Extra Design
openUsages	(O) List of Occurrence Name
count	(O) Count of Occurrence Name
childBOMLine	(O) Child AsBuiltBOMLine

ASBUILT_API int ASBUILT_get_all_open_usage_2	(	tag_t	parentPhysPart,
		tag_t	physicalPartRevision,
		logical	allUsages,
		char ***	usageType,
		char ***	openUsages,
		int *	count,
		tag_t **	childBOMLine
	)

DEPRECATED FUNCTION

ITK function to get all open usage values.

Deprecated:: This function is deprecated, it will be removed from Teamcenter 8.0.1. In its place use ASBUILT_get_all_open_usages_2

Parameters

parentPhysPart	(I) Parent Physical Part
physicalPartRevision	(I) Copied Physical Part Revision
allUsages	(I) Whether to fetch all the usages or preffered only
usageType	(I) Usage Type, Preferred , Other or Extra Design
openUsages	(O) List of Occurrence Name
count	(O) Count of Occurrence Name
childBOMLine	(O) Child AsBuiltBOMLine

ASBUILT_API int ASBUILT_get_all_open_usages	(	tag_t	inLine,
		tag_t	physicalPartRevision,
		char ***	openUsages,
		int *	count,
		tag_t **	childBOMLine
	)

ITK function to get all open usage values

Parameters

inLine	(I) Selected AsBuiltBOMLine
physicalPartRevision	(I) Copied Physical Part Revision
openUsages	(O) List of Occurrence Name
count	(O) Count of Occurrence Name
childBOMLine	(O) Child AsBuiltBOMLine

ASBUILT_API int ASBUILT_get_all_open_usages_2	(	tag_t	parentPhysPart,
		tag_t	physicalPartRevision,
		char ***	openUsages,
		int *	count,
		tag_t **	childBOMLine
	)

ITK function to get all open usage values

Parameters

parentPhysPart	(I) Parent Physical Part
physicalPartRevision	(I) Copied Physical Part Revision
openUsages	(O) List of Occurrence Name
count	(O) Count of Occurrence Name
childBOMLine	(O) Child AsBuiltBOMLine

ASBUILT_API int ASBUILT_init_module ( )

Initializes the asbuilt module. You must call this function before calling any other ASBUILT functions.

ASBUILT_API int ASBUILT_install_asbuilt_part_revision	(	tag_t	inLine,
		tag_t	physicalPartRevision,
		tag_t	selectedBOMLineImpl,
		InstallPartParams *	inParams,
		tag_t *	asbuiltStructure,
		tag_t *	installedLineTag
	)

ITK function to install AsBuilt Physical Part Revision in AsBuilt Structure

Parameters

inLine	(I) Selected AsBuiltBOMLine on which installation happens
physicalPartRevision	(I) Child Physical Part Revision which needs to be installed
selectedBOMLineImpl	(I) BOMLine - PSOccurrence - Position on which the installation happens
inParams	(I) Dialog Input
asbuiltStructure	(O) Create AsBuiltStructure relation
installedLineTag	(O) Installed AsBuiltBOMLine

ASBUILT_API int ASBUILT_install_asbuilt_part_revision_2	(	tag_t	inLine,
		tag_t	inParentPhysicalPartRev,
		tag_t	physicalPartRevision,
		tag_t	selectedBOMLineImpl,
		InstallPartParams *	inParams,
		tag_t *	asbuiltStructure,
		tag_t *	installedLineTag
	)

ITK function to install AsBuilt Physical Part Revision in AsBuilt Structure

Parameters

inLine	(I) Selected AsBuiltBOMLine on which installation happens
inParentPhysicalPartRev	(I) Parent Physical Part Revision
physicalPartRevision	(I) Child Physical Part Revision which needs to be installed
selectedBOMLineImpl	(I) BOMLine - PSOccurrence - Position on which the installation happens
inParams	(I) Dialog Input
asbuiltStructure	(O) Create AsBuiltStructure relation
installedLineTag	(O) Installed AsBuiltBOMLine

ASBUILT_API int ASBUILT_install_physical_part	(	tag_t	inLine,
		tag_t	physicalPartRevision,
		char *	usageType,
		tag_t	selectedBOMLineImpl,
		InstallPartParams *	inParams,
		tag_t *	allowedDeviation,
		tag_t *	asbuiltStructure,
		tag_t *	installedLineTag
	)

DEPRECATED FUNCTION

ITK function to install Physical Part in AsBuilt Structure.

Deprecated:: This function is deprecated, it will be removed from Teamcenter 8.0.1. In its place use ASBUILT_install_asbuilt_part_revision

Parameters

inLine	(I) Selected AsBuiltBOMLine on which installation happens
physicalPartRevision	(I) Child Physical Part Revision which needs to be installed
usageType	(I) Type of Usage (Other, Preferred, Extra To Design)
selectedBOMLineImpl	(I) BOMLine - PSOccurrence - Position on which the installation happens
inParams	(I) Dialog Input
allowedDeviation	(O) Created Allowed Deviation
asbuiltStructure	(O) Create AsBuiltStructure relation
installedLineTag	(O) Installed AsBuiltBOMLine

ASBUILT_API int ASBUILT_install_physical_part_2	(	tag_t	inLine,
		tag_t	inParentPhysicalPart,
		tag_t	physicalPartRevision,
		char *	usageType,
		tag_t	selectedBOMLineImpl,
		InstallPartParams *	inParams,
		tag_t *	allowedDeviation,
		tag_t *	asbuiltStructure,
		tag_t *	installedLineTag
	)

DEPRECATED FUNCTION

ITK function to install Physical Part in AsBuilt Structure.

Deprecated:: This function is deprecated, it will be removed from Teamcenter 8.0.1. In its place use ASBUILT_install_asbuilt_part_revision_2

Parameters

inLine	(I) Selected AsBuiltBOMLine on which installation happens
inParentPhysicalPart	(I) Parent Physical Part
physicalPartRevision	(I) Child Physical Part Revision which needs to be installed
usageType	(I) Type of Usage (Other, Preferred, Extra To Design)
selectedBOMLineImpl	(I) BOMLine - PSOccurrence - Position on which the installation happens
inParams	(I) Dialog Input
allowedDeviation	(O) Created Allowed Deviation
asbuiltStructure	(O) Create AsBuiltStructure relation
installedLineTag	(O) Installed AsBuiltBOMLine

ASBUILT_API int ASBUILT_line_ask_all_child_lines	(	tag_t	bom_line,
		int *	count,
		tag_t **	children
	)

ITK function to get Child Lines for selected Physical BOM Line

Parameters

bom_line	(I) Tag of BOM Line
count	(O) Count
children	(OF) Tags of Child BOM Lines

ASBUILT_API int ASBUILT_line_set_window_top	(	tag_t	window,
		tag_t	physicalPart,
		tag_t	physicalPartRevision,
		tag_t *	topBOMLine
	)

ITK function to set top AsBuilt BOM Line in MRO BOM Window

Parameters

window	(I) Tag of MRO BOM Window
physicalPart	(I) Tag of Physical Part
physicalPartRevision	(I) Tag of Physical Part Revision
topBOMLine	(O) Tag of top BOM Line

ASBUILT_API int ASBUILT_rebuild_asbuilt_structure	(	tag_t	inLine,
		date_t	rebuildDate,
		tag_t *	newPhysPartRev
	)

ITK function to rebuild AsBuilt Structure

Parameters

inLine	(I) Selected BOM line for rebuild
rebuildDate	(I) Rebuild date for asbuilt structure
newPhysPartRev	(O) Created AsBuilt Physical Part Revision

ASBUILT_API int ASBUILT_replace_physical_part	(	tag_t	selectedAsbuiltBOMLline,
		tag_t	copiedPhysPartRevision,
		InstallPartParams *	params,
		tag_t *	replacerAsbuiltBOMLine
	)

ITK function to replace Physical Part in an AsBuilt structure

Parameters

selectedAsbuiltBOMLline	(I) Selected AsBuiltBOMLine on which replace happens
copiedPhysPartRevision	(I) Copied Physical Part Revision
params	(I) Dialog Input
replacerAsbuiltBOMLine	(O) Replaced AsBuiltBOMLine

ASBUILT_API int ASBUILT_search_installable_physical_part_revisions	(	tag_t	selParentPhysBOMLine,
		tag_t	selectedBOMLineImpl,
		int	attrCount,
		char **	attributeNames,
		char **	attributeValues,
		SearchInstallableAsbPhysPartParams *	outParams
	)

ITK function to search installable physical part revisions

Parameters

selParentPhysBOMLine	(I) Selected parent physical BOM line.
selectedBOMLineImpl	(I) UsageBOMLine - PSOccurrence - Position on which the installation happens.
attrCount	(I) Total number of attributes on which search will be performed.
attributeNames	(I) Attribute names for which search will be performed.
attributeValues	(I) Attribute values for which search will be performed.
outParams	(O) Output structure with all preferred/deviated/substiture/ alternamte physical part revision and respective count.

Modules

Data Structures

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation