![]() |
T4S4
19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
AddOccurrence2AllLevelOccurrenceDict hOccurrence hRootOcc | |
Init the dict. More... | |
GetAllOccurenceInstances2Dict hOccurrence | |
get the Instances of an Occurence object to dict More... | |
GetAllPlmXmlActivityInfos2Dict hConfiguredActivity hParentActivity hRootActivity ?hOperation? args | |
Get the Activites of an Operation. More... | |
GetAllPlmXmlActivityInfos4Operation2Dict hOperation args | |
Get the Activites of an Operation. More... | |
GetAllPlmXmlButtomUpOccurrenceInfos4Child2Dict hDocument hRootChildOcc hChildOcc ?lButtomUpOccPath? args | |
Get all occurrences and all info of occurrence to dict for given child in a button up manner -> used for example getting MBOM structure created starting from Linked Occurrence. More... | |
GetAllPlmXmlDataSetInfos2Dict hDocument args | |
Get all infos of forms to dict. More... | |
GetAllPlmXmlExternalFileInfos2Dict hDocument args | |
Get all infos of External Files. More... | |
GetAllPlmXmlFormInfos2Dict hDocument args | |
Get all infos of forms to dict. More... | |
GetAllPlmXmlGeneralRelationInfos2Dict hDocument args | |
Get all infos of all GeneralRelations to dict. More... | |
GetAllPlmXmlIdentifierInfos2Dict hDocument args | |
Get all infos of forms to dict. More... | |
GetAllPlmXmlItemInfos2Dict hDocument args | |
Get all infos for all Items dict. More... | |
GetAllPlmXmlLotInfos2Dict hDocument args | |
Get all infos of LOT - Lot a represented as LotRevision. More... | |
GetAllPlmXmlReleaseStatusInfos2Dict hDocument args | |
Get all infos of forms to dict. More... | |
GetAllPlmXmlRevisionInfos2Dict hDocument args | |
Get all infos of all Revisions to dict. More... | |
GetAllPlmXmlStructureHeadersInfosByCollaborationContext2Dict hDocument args | |
Get all infos of all Headers (Bom, Bop, ...) to dict based on a CC. More... | |
GetAllPlmXmlStructureHeadersInfosByPlmxmlRoot2Dict hDocument args | |
Get all infos of all Headers (Bom, Bop, ...) to dict by a header occ as the root of the PLMXML. More... | |
GetAllPlmXmlStuctureHeaderInfos2Dict hHeader sStructureType ?sStructureContextType? args | |
Get all infos of all Headers (Bom, Bop, ...) to dict. More... | |
GetAllPlmXmlTopDownOccurrencesInfos4Parent2Dict hDocument hRootParentOcc hParentOcc ?iStartLevel? ?iMaxLevel? args | |
Depricated! Please use GetPlmlXmlStructure4Occurrence2Dict instead. More... | |
GetAllPlmXmlTopDownOccurrencesInfos4Parent2DictV2 hDocument hRootParentOcc hParentOcc ?iStartLevel? ?iMaxLevel? args | |
Get all occurences and all info of occurence to dict for given header and levels in top down manner. More... | |
GetAllPlmXmlUnitInfos2Dict hDocument args | |
Get all infos of LOT - Lot a represented as LotRevision. More... | |
GetAssociatedAttachmentDataSetInfos hObject args | |
Gives label / object_tag of a object / handle of Attachments. More... | |
GetAssociatedItemFormInfos hObject args | |
Gives label / object_tag of a object / handle of MasterForm. More... | |
GetCollaborationContextInfos2Dict hDocument args | |
Get Infos of CC. More... | |
GetDeltaXmlObjectAttributeValue sObjectType hObject ?sAttrKey? args | |
Function to read infos from the DeltaXML dict DeltaXmlInfos in a secure way. More... | |
GetDescription hObject args | |
gives desc of an Object More... | |
GetInsertionStrin4StructureLevel iLevel | |
Print the dict to a given log channel. More... | |
GetObjectAttributeValue sObjectType hObject ?sAttrKey? args | |
Returns the value of specified attribute for the given object handle. More... | |
GetOccurrenceAssociatedAttachment2Dict hOccurence args | |
Gives label / object_tag of a object / handle of Attachments. More... | |
GetPlmlXmlInfos2Dict Document ?lStructureHeaderTypes? | |
Reads the PLMXML content into a TCL dict. More... | |
GetPlmlXmlObjectInfos2Dict Document | |
Reads the PLMXML content into a TCL dict. Understands if export is CC based or not does not read structures only objects like Item, ItemRevision etc. More... | |
GetPlmlXmlReadCtrlParameter sParameter | |
Init the dict. More... | |
GetPlmlXmlStructure4Occurrence2Dict Document hHeaderOcc ?iStartLevel? ?iMaxLevel? | |
Reads the PLMXML structure into the dict. More... | |
GetPlmlXmlStructure4StructureHeader2Dict Document sStructureHeaderTypes ?iMaxLevel? | |
Reads the PLMXML content into a TCL dict. More... | |
GetPlmXmlFileInfos2Dict hDocument args | |
GetPlmXmlObjectApplRefLabelAndVersion handle args | |
Gives label / object_tag of a object / handle. More... | |
GetPlmXmlObjectAttributeValue sObjectType hObject ?sAttrKey? args | |
Returns the value of specified attribute for the given object handle. More... | |
GetPlmXmlObjectHandleById sObjectType sSearchId args | |
get the Handle for a PLMXML Id Was implemented as workaround. Should not be needed! More... | |
GetPlmXmlObjectTableRowInfos2Dict hSourceObject args | |
Reads the TableRow of an objects and save it. The property which points to the table row points to this objects. More... | |
GetPlmXmlObjectUserDataValues hObject args | |
Get all UserData Values of a given Object handle. More... | |
GetStructureContextInfos2Dict hCCContextChild ?hAttachment? ?sContextType? | |
Get the rules etc for a structure context. More... | |
GetStructureType4StructureContextType sStructureContextType | |
converts structure Context type to structre type using the control parameters More... | |
GetSubsituteOccurrenceInfos2Dict hDocument hOccurrence hMainOcc args | |
get the Subsitute Occ infos to dict More... | |
InitPlmlXmlInfosDict Document args | |
Init the dict. More... | |
PrintAllStructureLevelDict2LogChannel sLogChannel hHeaderOcc iLevel | |
Print the dict to a given log channel. More... | |
PrintDict2LogChannel sLogChannel | |
Print the dict to a given log channel. More... | |
PrintMethods Object ?count? | |
PrintObjectDict2LogChannel sLogChannel | |
Print the dict to a given log channel. More... | |
PrintPlmlXmlReadCtrlParameter args | |
Init the dict. More... | |
PrintStructureDict2LogChannel sLogChannel | |
Print the dict to a given log channel. More... | |
SetPlmXmlInfo sObjectType hObject ?sAttrKey? ?sAttrValue? args | |
Sets infos from dict in a secure way. More... | |
UseDeltaXmlInfo sObjectType hObject ?sAttrKey? args | |
Validates if the requested information is part of the delta XML. More... | |
Variables | |
DeltaXmlInfos | |
PlmXmlInfos | |
PlmXmlReadCtrl | |
T4X::PLMXML::READ2DICT::AddOccurrence2AllLevelOccurrenceDict | hOccurrence hRootOcc | ||
Init the dict.
Document | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllOccurenceInstances2Dict | hOccurrence | ||
get the Instances of an Occurence object to dict
hOccurrence | - Subsitute Occ |
T4X::PLMXML::READ2DICT::GetAllPlmXmlActivityInfos2Dict | hConfiguredActivity hParentActivity hRootActivity ?hOperation? args | ||
Get the Activites of an Operation.
hOperation | - |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlActivityInfos4Operation2Dict | hOperation args | ||
Get the Activites of an Operation.
hOperation | - |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlButtomUpOccurrenceInfos4Child2Dict | hDocument hRootChildOcc hChildOcc ?lButtomUpOccPath? args | ||
Get all occurrences and all info of occurrence to dict for given child in a button up manner -> used for example getting MBOM structure created starting from Linked Occurrence.
hDocument | - Handle of the plmxml document |
hRootChildOcc | - |
hChildOcc | - |
lButtomUpOccPath | - |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlDataSetInfos2Dict | hDocument args | ||
Get all infos of forms to dict.
hDocument | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlExternalFileInfos2Dict | hDocument args | ||
Get all infos of External Files.
hDocument | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlFormInfos2Dict | hDocument args | ||
Get all infos of forms to dict.
hDocument | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlGeneralRelationInfos2Dict | hDocument args | ||
Get all infos of all GeneralRelations to dict.
hDocument | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlIdentifierInfos2Dict | hDocument args | ||
Get all infos of forms to dict.
hDocument | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlItemInfos2Dict | hDocument args | ||
Get all infos for all Items dict.
hDocument | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlLotInfos2Dict | hDocument args | ||
Get all infos of LOT - Lot a represented as LotRevision.
hDocument | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlReleaseStatusInfos2Dict | hDocument args | ||
Get all infos of forms to dict.
hDocument | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlRevisionInfos2Dict | hDocument args | ||
Get all infos of all Revisions to dict.
hDocument | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlStructureHeadersInfosByCollaborationContext2Dict | hDocument args | ||
Get all infos of all Headers (Bom, Bop, ...) to dict based on a CC.
hDocument | - Handle of the plmxml document |
args | - not used |
2015-06-19: The headers may not be a CC... for Partial XML it is only the BOP -> Renamed to
T4X::PLMXML::READ2DICT::GetAllPlmXmlStructureHeadersInfosByPlmxmlRoot2Dict | hDocument args | ||
Get all infos of all Headers (Bom, Bop, ...) to dict by a header occ as the root of the PLMXML.
hDocument | - Handle of the plmxml document |
args | - not used |
2015-06-19: The headers may not be a CC... for Partial XML it is only the BOP -> Renamed to
T4X::PLMXML::READ2DICT::GetAllPlmXmlStuctureHeaderInfos2Dict | hHeader sStructureType ?sStructureContextType? args | ||
Get all infos of all Headers (Bom, Bop, ...) to dict.
hHeader | - |
sStructureType | - |
args | - not used |
2015-06-19: The headers may not be a CC... for Partial XML it is only the BOP -> Renamed to
T4X::PLMXML::READ2DICT::GetAllPlmXmlTopDownOccurrencesInfos4Parent2Dict | hDocument hRootParentOcc hParentOcc ?iStartLevel? ?iMaxLevel? args | ||
Depricated! Please use GetPlmlXmlStructure4Occurrence2Dict instead.
hDocument | - Handle of the plmxml document |
hRootParentOcc | - |
hParentOcc | - |
iStartLevel | - |
iMaxLevel | - |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlTopDownOccurrencesInfos4Parent2DictV2 | hDocument hRootParentOcc hParentOcc ?iStartLevel? ?iMaxLevel? args | ||
Get all occurences and all info of occurence to dict for given header and levels in top down manner.
hDocument | - Handle of the plmxml document |
hRootParentOcc | - |
hParentOcc | - |
iStartLevel | - |
iMaxLevel | - |
args | - not used |
T4X::PLMXML::READ2DICT::GetAllPlmXmlUnitInfos2Dict | hDocument args | ||
Get all infos of LOT - Lot a represented as LotRevision.
hDocument | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::GetAssociatedAttachmentDataSetInfos | hObject args | ||
Gives label / object_tag of a object / handle of Attachments.
hObject | - Handle of the object |
args | - not used |
AssociatedDataSet id="id65" dataSetRef="#id56" role="IMAN_specification"
T4X::PLMXML::READ2DICT::GetAssociatedItemFormInfos | hObject args | ||
Gives label / object_tag of a object / handle of MasterForm.
hObject | - Handle of the object |
args | - not used |
T4X::PLMXML::READ2DICT::GetCollaborationContextInfos2Dict | hDocument args | ||
Get Infos of CC.
T4X::PLMXML::READ2DICT::GetDeltaXmlObjectAttributeValue | sObjectType hObject ?sAttrKey? args | ||
Function to read infos from the DeltaXML dict DeltaXmlInfos in a secure way.
sObjectType | - |
hObject | - |
sAttrKey | - |
args | - not used |
T4X::PLMXML::READ2DICT::GetDescription | hObject args | ||
gives desc of an Object
hObject | - Handle of the object |
args | - not used |
T4X::PLMXML::READ2DICT::GetInsertionStrin4StructureLevel | iLevel | ||
Print the dict to a given log channel.
iLevel | - level in the structure |
T4X::PLMXML::READ2DICT::GetObjectAttributeValue | sObjectType hObject ?sAttrKey? args | ||
Returns the value of specified attribute for the given object handle.
Reads infos from dict in a secure way
sObjectType | Object type (e.g. Occurrences, Item, ...) |
hObject | This is the object handle used to access the extracted data in the Dict buffer if the object handle is not found in the buffer the function will return an error. |
sAttrKey | attribute name |
args | additional arguments, currently unused. |
T4X::PLMXML::READ2DICT::GetOccurrenceAssociatedAttachment2Dict | hOccurence args | ||
Gives label / object_tag of a object / handle of Attachments.
hOccurence | - Handle of the object |
args | - not used |
<Occurrence id="id229" associatedattachmentrefs="#id231" parentref="#id215"> <AssociatedAttachment id="id231" attachmentref="#id233" role="Mes0MEDCD_Details" contextref="#id215">
T4X::PLMXML::READ2DICT::GetPlmlXmlInfos2Dict | Document ?lStructureHeaderTypes? | ||
Reads the PLMXML content into a TCL dict.
using the following parameters in the PlmXmlReadCtrl dict to control the read procedure
dict set PlmXmlReadCtrl OperationItemTypeList [list MEOP MEDrill MEEDM MEMillTurn MEMilling MENCMachining METurning MEWEDM Mfg0MEContJoinOP Mfg0MEDiscreteOP] the read procedure checks if an Occ is an Operation or not by checking the type, if there is an activity, if nothing is clear this list is taken into againt in the last place dict set PlmXmlReadCtrl StructureContextType2StructureTypeMappping [list [list "MEProductContext" "Product"] [list "MEProcessContext" "Process"] [list "MEPlantContext" "Plant"]] Mapping of CC structure context type to object tpye. The read procs understand Product, Process and Plant and if there is a custom context type, just add it. Not known will be assinged to UNKNOWN dict set PlmXmlReadCtrl ReadMasterForm "false" read the IM and IRM of the Item and ItemRevisions into the dict if you could not avoid exporting them they are skipped by default dict set PlmXmlReadCtrl ReadIds "false" read PLMXML Id into the dict. Mainly not needed dict set PlmXmlReadCtrl ObjectList [list "GeneralRelation" "Item" "Revision" "Form" "Identifier" "ReleaseStatus" "DataSet" "Lot" "Unit"] list the objects you want to read in the dict. The default list is the supported list. Do not add new ones. Use it if you could not avoid exporting a object but do not need it dict set PlmXmlReadCtrl ProcessOccTypes4CrawlUpRead [list "MEConsumed" "MEAssemble"] do not read / export the Product / BOM if you do not need it. using plmxml structure crawl up the consumed and its parent are exported anyhow. Define for which occ type you want to read the info dict set PlmXmlReadCtrl ItemSubTypes [list "Product" "Process" "WorkArea" "Operation" "Change" "RealisedProduct"] if you read Items / ItemRevision you can use this parameter to restrict the read to specific types. The default ones are the suppoted once
Document | - Handle of the plmxml document |
lStructureHeaderTypes | - List of Header Types example: Product Process Plant for which the structures should be read. Default is "none" |
T4X::PLMXML::READ2DICT::GetPlmlXmlObjectInfos2Dict | Document | ||
Reads the PLMXML content into a TCL dict. Understands if export is CC based or not does not read structures only objects like Item, ItemRevision etc.
Document | - Handle of the plmxml document |
T4X::PLMXML::READ2DICT::GetPlmlXmlReadCtrlParameter | sParameter | ||
Init the dict.
sParameter | - control parameter the value should be read |
T4X::PLMXML::READ2DICT::GetPlmlXmlStructure4Occurrence2Dict | Document hHeaderOcc ?iStartLevel? ?iMaxLevel? | ||
Reads the PLMXML structure into the dict.
Document | - Handle of the plmxml document |
hHeaderOcc | - Starting Occ |
iStartLevel | - default is 1 if the Header Occ is on a different level this can be handed over for counting |
iMaxLevel | - levels to read ... default is ALL which means ALL Levels restrict that using your Closure Rule |
T4X::PLMXML::READ2DICT::GetPlmlXmlStructure4StructureHeader2Dict | Document sStructureHeaderTypes ?iMaxLevel? | ||
Reads the PLMXML content into a TCL dict.
Document | - Handle of the plmxml document |
sStructureHeaderTypes | - Product, Process, Plant |
iMaxLevel | - levels to read ... default is ALL which means ALL Levels restrict that using your Closure Rule |
T4X::PLMXML::READ2DICT::GetPlmXmlFileInfos2Dict | hDocument args | ||
T4X::PLMXML::READ2DICT::GetPlmXmlObjectApplRefLabelAndVersion | handle args | ||
Gives label / object_tag of a object / handle.
handle | - |
args | - not used |
T4X::PLMXML::READ2DICT::GetPlmXmlObjectAttributeValue | sObjectType hObject ?sAttrKey? args | ||
Returns the value of specified attribute for the given object handle.
Reads infos from dict in a secure way
sObjectType | - Object type (e.g. Occurrences, Item, ...) |
hObject | - This is the object handle used to access the extracted data in the Dict buffer if the object handle is not found in the buffer the function will return an error. |
sAttrKey | - attribute name |
args | - additional arguments, currently unused. |
T4X::PLMXML::READ2DICT::GetPlmXmlObjectHandleById | sObjectType sSearchId args | ||
get the Handle for a PLMXML Id Was implemented as workaround. Should not be needed!
sObjectType | - |
sSearchId | - |
args | - not used |
T4X::PLMXML::READ2DICT::GetPlmXmlObjectTableRowInfos2Dict | hSourceObject args | ||
Reads the TableRow of an objects and save it. The property which points to the table row points to this objects.
Get all infos of forms to dict
hSourceObject | - |
args | - not used |
T4X::PLMXML::READ2DICT::GetPlmXmlObjectUserDataValues | hObject args | ||
Get all UserData Values of a given Object handle.
T4X::PLMXML::READ2DICT::GetStructureContextInfos2Dict | hCCContextChild ?hAttachment? ?sContextType? | ||
Get the rules etc for a structure context.
hCCContextChild | - Handle of the plmxml CC context |
hAttachment | - optional |
sContextType | |
args | - not used |
T4X::PLMXML::READ2DICT::GetStructureType4StructureContextType | sStructureContextType | ||
converts structure Context type to structre type using the control parameters
sStructureContextType | - IMAN_CCContext |
T4X::PLMXML::READ2DICT::GetSubsituteOccurrenceInfos2Dict | hDocument hOccurrence hMainOcc args | ||
get the Subsitute Occ infos to dict
hDocument | - Handle of the plmxml document |
hOccurrence | - Subsitute Occ |
hMainOcc | |
args | - not used |
T4X::PLMXML::READ2DICT::InitPlmlXmlInfosDict | Document args | ||
Init the dict.
Document | - Handle of the plmxml document |
args | - not used |
T4X::PLMXML::READ2DICT::PrintAllStructureLevelDict2LogChannel | sLogChannel hHeaderOcc iLevel | ||
Print the dict to a given log channel.
sLogChannel | - logchannel the info should be printed |
T4X::PLMXML::READ2DICT::PrintDict2LogChannel | sLogChannel | ||
Print the dict to a given log channel.
sLogChannel | - logchannel the info should be printed |
T4X::PLMXML::READ2DICT::PrintMethods | Object ?count? | ||
Object | |
count |
T4X::PLMXML::READ2DICT::PrintObjectDict2LogChannel | sLogChannel | ||
Print the dict to a given log channel.
sLogChannel | - logchannel the info should be printed |
T4X::PLMXML::READ2DICT::PrintPlmlXmlReadCtrlParameter | args | ||
Init the dict.
args | - not used |
T4X::PLMXML::READ2DICT::PrintStructureDict2LogChannel | sLogChannel | ||
Print the dict to a given log channel.
sLogChannel | - logchannel the info should be printed |
T4X::PLMXML::READ2DICT::SetPlmXmlInfo | sObjectType hObject ?sAttrKey? ?sAttrValue? args | ||
Sets infos from dict in a secure way.
sObjectType | - |
hObject | - Handle of the object |
sAttrKey | - |
sAttrValue | - |
args | - not used |
T4X::PLMXML::READ2DICT::UseDeltaXmlInfo | sObjectType hObject ?sAttrKey? args | ||
Validates if the requested information is part of the delta XML.
Reads infos from dict in a secure way
sObjectType | - Object type (e.g. Occurrences, Item, ...) |
hObject | This is the object handle used to access the extracted data in the Dict buffer if the object handle is not found in the buffer the function will return an error. |
sAttrKey | - attribute name |
args | - additional arguments |
|
static |
|
static |
|
static |