T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
ASBUILT ITK functions

All ITK functions of group ASBUILT supported by T4x. More...

Functions

 ASBUILT_bom_compare_no_context hexSourceLineTag hexTargetLineTag compareMode outputMode
 ITK function for AsBuilt BOM Compare. More...
 
 ASBUILT_build_physical_part_revision hexPhysicalPartRevTag EffectiveFromDate
 ITK function to revise As-Built Physical Part Revision Tag of new Physical Element Revision. More...
 
 ASBUILT_create_compare_desc
 ITK function to create compare descriptor for BOM Compare. More...
 
 ASBUILT_create_missing_part_structure hexSelectBOMLineTag
 ITK function to create missing part AsBuilt structure. More...
 
 ASBUILT_gen_phystruc hexNeutralBOMLineTag attributeName1
 ITK function to generate AsBuilt Structure. More...
 
 ASBUILT_get_all_open_usages hexInLineTag hexPhysicalPartRevTag
 ITK function to get all open usage values. More...
 
 ASBUILT_get_all_open_usages_2 hexInLineTag hexPhysicalPartRevTag
 ITK function to get all open usage values. More...
 
 ASBUILT_init_module
 Initializes the as-built module. Must be called before calling any other ASBUILT functions. More...
 
 ASBUILT_install_asbuilt_part_revision hexInLineTag hexPhysicalPartRevTag hexSelectBOMLineImplTag UsageName InstallationDate
 ITK function to install AsBuilt Physical Part Revision in AsBuilt Structure. More...
 
 ASBUILT_install_asbuilt_part_revision_2 hexInLineTag hexPhysicalPartRevTag hexChildPhysicalPartRevTag hexSelectBOMLineImplTag UsageName InstallationDate
 ITK function to install AsBuilt Physical Part Revision in AsBuilt Structure. More...
 
 ASBUILT_line_ask_all_child_lines hexBOMLineTag
 ITK function to get Child Lines for selected Physical BOM Line. More...
 
 ASBUILT_line_set_window_top WindowTag hexPhysicalPartTag hexPhysicalPartRevisionTag
 ITK function to set top AsBuilt BOM Line in MRO BOM Window. More...
 
 ASBUILT_rebuild_asbuilt_structure hexSelectBOMLineTag RebuildDate
 ITK function to rebuild AsBuilt Structure. More...
 
 ASBUILT_replace_physical_part hexSelectBOMLineTag hexPhysicalPartRevision UsageName InstallationDate
 ITK function to replace Physical Part in an AsBuilt structure. More...
 
 ASBUILT_search_installable_physical_part_revisions hexParentPhysBOMLineTag hexUsageBOMLineTag attributeName1
 ITK function to search installable physical part revisions. More...
 

Detailed Description

All ITK functions of group ASBUILT supported by T4x.

This group specifies all ITK functions of group ASBUILT for which wrappers have been defined in T4x

Function Documentation

◆ ASBUILT_bom_compare_no_context()

ITK::ASBUILT_bom_compare_no_context   hexSourceLineTag hexTargetLineTag compareMode outputMode  

ITK function for AsBuilt BOM Compare.

Parameters
hexSourceLineTag- Tag of Source Line
hexTargetLineTag- Tag of target Line
compareMode- String - BOM Compare Mode
outputMode- Int - Output to
Returns
list of ITK_ok (=0) and 3 lists with 1-hexCheckedLineTags 2-hexMatchedLineTags 3-hexReportLines or list of ITK status and error message

◆ ASBUILT_build_physical_part_revision()

ITK::ASBUILT_build_physical_part_revision   hexPhysicalPartRevTag EffectiveFromDate  

ITK function to revise As-Built Physical Part Revision Tag of new Physical Element Revision.

Parameters
hexPhysicalPartRevTag- Tag of Physical Part Revision to be revised
EffectiveFromDate- string format = Y.m.d H:M:S
Returns
list of ITK_ok (=0) and hexNewPhysicalPartRevTag or list of ITK status and error message

◆ ASBUILT_create_compare_desc()

ITK::ASBUILT_create_compare_desc

ITK function to create compare descriptor for BOM Compare.

Returns
ITK_ok (=0) or list of ITK status and error message

◆ ASBUILT_create_missing_part_structure()

ITK::ASBUILT_create_missing_part_structure   hexSelectBOMLineTag  

ITK function to create missing part AsBuilt structure.

Parameters
hexSelectBOMLineTag- Tag of selected AsBuilt BOM Line
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ASBUILT_gen_phystruc()

ITK::ASBUILT_gen_phystruc   hexNeutralBOMLineTag attributeName1  

ITK function to generate AsBuilt Structure.

Parameters
hexNeutralBOMLineTag- Parent BOM line whose children are wanted
attributeName1attributeValue1 ... attributeNameX attributeValueX - Attribute names and values for which search will be performed.
Returns
list of ITK_ok (=0) and PhysPartRevisionTag or list of ITK status and error message

◆ ASBUILT_get_all_open_usages()

ITK::ASBUILT_get_all_open_usages   hexInLineTag hexPhysicalPartRevTag  

ITK function to get all open usage values.

Parameters
hexInLineTag- Selected AsBuiltBOMLine
hexPhysicalPartRevTag- Copied Physical Part Revision
Returns
list of ITK_ok (=0) and list of pairs with open usage tag and occurrence name - ok or list of ITK status and error message

◆ ASBUILT_get_all_open_usages_2()

ITK::ASBUILT_get_all_open_usages_2   hexInLineTag hexPhysicalPartRevTag  

ITK function to get all open usage values.

Parameters
hexInLineTag- Selected AsBuiltBOMLine
hexPhysicalPartRevTag- Copied Physical Part Revision
Returns
list of ITK_ok (=0) and list of pairs with open usage tag and occurrence name - ok or list of ITK status and error message

◆ ASBUILT_init_module()

ITK::ASBUILT_init_module

Initializes the as-built module. Must be called before calling any other ASBUILT functions.

Returns
ITK_ok (=0) or list of ITK status and error message

◆ ASBUILT_install_asbuilt_part_revision()

ITK::ASBUILT_install_asbuilt_part_revision   hexInLineTag hexPhysicalPartRevTag hexSelectBOMLineImplTag UsageName InstallationDate  

ITK function to install AsBuilt Physical Part Revision in AsBuilt Structure.

Parameters
hexInLineTag- Selected AsBuiltBOMLine on which installation happens
hexPhysicalPartRevTag- Child Physical Part Revision which needs to be installed
hexSelectBOMLineImplTag- BOMLine - PSOccurrence - Position on which the installation happens
UsageName- string
InstallationDate- string format = Y.m.d H:M:S
Returns
list of ITK_ok (=0), hexAsbuiltStructureTag and hexInstalledLineTag or list of ITK status and error message

◆ ASBUILT_install_asbuilt_part_revision_2()

ITK::ASBUILT_install_asbuilt_part_revision_2   hexInLineTag hexPhysicalPartRevTag hexChildPhysicalPartRevTag hexSelectBOMLineImplTag UsageName InstallationDate  

ITK function to install AsBuilt Physical Part Revision in AsBuilt Structure.

Parameters
hexInLineTag- Selected AsBuiltBOMLine on which installation happens
hexPhysicalPartRevTag- Parent Physical Part Revision
hexChildPhysicalPartRevTag- Child Physical Part Revision which needs to be installed
hexSelectBOMLineImplTag- BOMLine - PSOccurrence - Position on which the installation happens
UsageName- string
InstallationDate- string format = Y.m.d H:M:S
Returns
list of ITK_ok (=0), hexAsbuiltStructureTag and hexInstalledLineTag or list of ITK status and error message

◆ ASBUILT_line_ask_all_child_lines()

ITK::ASBUILT_line_ask_all_child_lines   hexBOMLineTag  

ITK function to get Child Lines for selected Physical BOM Line.

Parameters
hexBOMLineTag- Tag of BOM Line
Returns
list of ITK_ok (=0) and hexChildrenTag1... hexChildrenTagX or list of ITK status and error message

◆ ASBUILT_line_set_window_top()

ITK::ASBUILT_line_set_window_top   WindowTag hexPhysicalPartTag hexPhysicalPartRevisionTag  

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

Parameters
WindowTag- Tag of MRO BOM Window
hexPhysicalPartTag- Tag of Physical Part
hexPhysicalPartRevisionTag- Tag of Physical Part Revision
Returns
list of ITK_ok (=0) and hexTopBOMLineTag or list of ITK status and error message

◆ ASBUILT_rebuild_asbuilt_structure()

ITK::ASBUILT_rebuild_asbuilt_structure   hexSelectBOMLineTag RebuildDate  

ITK function to rebuild AsBuilt Structure.

Parameters
hexSelectBOMLineTag- Selected BOM line for rebuild
RebuildDate- string format = Y.m.d H:M:S
Returns
list of ITK_ok (=0) and hexNewPhysicalPartRevTag or list of ITK status and error message

◆ ASBUILT_replace_physical_part()

ITK::ASBUILT_replace_physical_part   hexSelectBOMLineTag hexPhysicalPartRevision UsageName InstallationDate  

ITK function to replace Physical Part in an AsBuilt structure.

Parameters
hexSelectBOMLineTag- Selected AsBuiltBOMLine on which replace happens
hexPhysicalPartRevision- Copied Physical Part Revision
UsageName- String
InstallationDate- string format = Y.m.d H:M:S
Returns
list of ITK_ok (=0) and hexReplacerAsbuiltBOMLineTag or list of ITK status and error message

◆ ASBUILT_search_installable_physical_part_revisions()

ITK::ASBUILT_search_installable_physical_part_revisions   hexParentPhysBOMLineTag hexUsageBOMLineTag attributeName1  

ITK function to search installable physical part revisions.

Parameters
hexParentPhysBOMLineTag- Selected parent physical BOM line.
hexUsageBOMLineTag- UsageBOMLine - PSOccurrence - Position on which the installation happens.
attributeName1attributeValue1 ... attributeNameX attributeValueX - Attribute names and values for which search will be performed.
Returns
list of ITK_ok (=0) and 4 lists with 1-preferred installable physical part revision objects, 2-alternate installable physical part revision objects 3-substitute installable physical part revision objects 4-deviated installable physical part revision objects - ok or list of ITK status and error message