![]() |
T4S4
18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
charactGetDataType CharatName ?KeyDate? ?blnMap5CharacterCharacteristic2Boolean? args | |
Returns the data type for a given characteristic. More... | |
charactGetDetail args | |
Retrieves detailed information of an existing SAP characteristic object. More... | |
classGetDetail args | |
Retrieves detailed information of an existing SAP class definition. More... | |
clearObjectClassificationCurrency args | |
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification:CharacteristicCurrValues. More... | |
clearObjectClassificationNumericValues args | |
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification:CharacteristicNumericValues. More... | |
clearObjectClassificationStringValues args | |
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification:CharacteristicStringValues. More... | |
getClassCharacteristics ClassNum ClassType ?Key_Date? ?Langu_INT? ?Langu_ISO? ?With_Values? | |
Retrieves all existing characteristics for a given SAP class object. More... | |
getDetailedObjectClassification args | |
Retrieves detailed information about an existing SAP object classification using the BAPI BAPI_OBJCL_GETDETAIL. More... | |
getObjectClassification args | |
Retrieves detailed information about an existing SAP object classification using the BAPI BAPI_OBJCL_GETCLASSES. More... | |
getSuperClassAllocs ClassNum ClassType KeyDate ?blnWithDescription? | |
Class Hierarchy BAPI: (Directly) Superior Classes This BAPI returns the superior classes directly above a class in a class hierarchy. The initial class must be transferred in field 'ClassNum', and the class type in field 'ClassType'. You can transfer a date ('KeyDate'). Output table 'SuperclassesList' contains the names of the superior classes ('ClassName') and the class type again. If the BAPI runs succesfully, table Return contains no messages of type 'E'. More... | |
initClassificationStructureChange args | |
Resets part of the corresponding global TCL ::SAPDat array within the section Class:PARAMETER. More... | |
initClassificationStructureCreate args | |
Resets part of the corresponding global TCL ::SAPDat array within the section Class:PARAMETER. More... | |
initObjectClassificationStructure args | |
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification. More... | |
mergeObjectClassification args | |
This function merges the result of the TPSAP::CLASS::getDetailedObjectClassification call with the new object classification defined by the mapping. It will copy all current values in SAP that are not specified by the mapping to the internal buffer that is used to update the object classification. This will avoid that not specified calcification values are deleted during the update via the BAPI_OBJCL_CHANGE function in SAP. More... | |
selectChangeMasterClassification ChangeNumber args | |
Stores the given SAP change master id into the global TCL ::SAPDat array for a future transfer. More... | |
selectClassificationDefinition ClassNumber ClassType KeyDate ChangeNumber StdClass Status args | |
Stores the given SAP class params into the global TCL ::SAPDat array for a future transfer. More... | |
selectDocumentClassification DocumentNumber DocumentType DocumentPart DocumentVersion args | |
Stores the given SAP document info record object key into the global TCL ::SAPDat array for a future transfer. More... | |
selectDocumentObjectLinkClassification LinkNumber args | |
Stores the given SAP document object link object key into the global TCL ::SAPDat array for a future transfer. More... | |
selectGenericObjectLinkClassification ObjectKey ObjectTable args | |
Stores the given SAP object key and the object table into the global TCL ::SAPDat array for a future transfer. This function enables T4S to maintain generic object classifications. More... | |
selectMaterialMasterClassification MaterialNumber args | |
Stores the given SAP material master id into the global TCL ::SAPDat array for a future transfer. More... | |
selectPlanClassification PlanType GroupId GroupCounter args | |
Stores the given SAP routing object key into the global TCL ::SAPDat array for a future transfer. More... | |
setClassification_by_Reference ObjectKey TargetObjectKey args | |
Used to create a MM object classification based on an existing SAP MM object classification. More... | |
storeObjectClassificationCurrency Index CHARACT VALUE_FROM VALUE_TO VALUE_RELATION CURRENCY_FROM_ISO CURRENCY_TO_ISO INHERITED INSTANCE CHARACT_DESCR args | |
Sets the input structure for the ALLOCVALUESCURR->Classification BAPI for a future transfer - Values of Type CURR. More... | |
storeObjectClassificationNumericValue Index CHARACT VALUE_FROM VALUE_TO VALUE_RELATION UNIT_FROM_ISO UNIT_TO_ISO INHERITED INSTANCE CHARACT_DESCR args | |
Sets the input structure for the Classification BAPI for a future transfer - Values of Type NUM, DATE, TIME. More... | |
storeObjectClassificationStringValue Index CHARACT VALUE_CHAR INHERITED INSTANCE VALUE_NEUTRAL CHARACT_DESCR args | |
Sets the input structure for the Classification BAPI for a future transfer - Values of Type CHAR, BOOL. More... | |
TPSAP::CLASS::charactGetDataType | CharatName ?KeyDate? ?blnMap5CharacterCharacteristic2Boolean? args | ||
Returns the data type for a given characteristic.
CharatName | |
KeyDate | - OPTIONAL (default empty) |
blnMap5CharacterCharacteristic2Boolean | - OPTIONAL (default TRUE) - If TRUE, a CHAR characteristic with the length of 5 and only the 2 values TRUE and FALSE will be mapped to type BOOLEAN |
References charactGetDetail(), and TPSAP::getSessionLogChannel().
TPSAP::CLASS::charactGetDetail | args | ||
Retrieves detailed information of an existing SAP characteristic object.
Sample code sequence
References TPSAP::getSessionLogChannel(), and tpco_scanHEX16().
Referenced by charactGetDataType().
TPSAP::CLASS::classGetDetail | args | ||
Retrieves detailed information of an existing SAP class definition.
Sample code sequence
References TPSAP::getSessionLogChannel(), and tpco_scanHEX16().
TPSAP::CLASS::clearObjectClassificationCurrency | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification:CharacteristicCurrValues.
args | none |
References TPSAP::getSessionLogChannel().
Referenced by initObjectClassificationStructure().
TPSAP::CLASS::clearObjectClassificationNumericValues | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification:CharacteristicNumericValues.
args | none |
References TPSAP::getSessionLogChannel().
Referenced by initObjectClassificationStructure().
TPSAP::CLASS::clearObjectClassificationStringValues | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification:CharacteristicStringValues.
args | none |
References TPSAP::getSessionLogChannel().
Referenced by initObjectClassificationStructure().
TPSAP::CLASS::getClassCharacteristics | ClassNum ClassType ?Key_Date? ?Langu_INT? ?Langu_ISO? ?With_Values? | ||
Retrieves all existing characteristics for a given SAP class object.
ClassNum | Class Name |
ClassType | Class Type |
Key_Date | (optional) Validity Time |
Langu_INT | (optional) Internal Language Key |
Langu_ISO | (optional) ISO Language Key |
With_Values | (optional) (X or empty) Find Allowed Values |
Sample code sequence
References TPSAP::getSessionLogChannel().
TPSAP::CLASS::getDetailedObjectClassification | args | ||
Retrieves detailed information about an existing SAP object classification using the BAPI BAPI_OBJCL_GETDETAIL.
Sample code sequence
References TPSAP::getLoginLanguageISO(), TPSAP::getSessionLogChannel(), tpco_scanHEX16(), and tpwrite().
Referenced by setClassification_by_Reference(), and TPSAP::MM::setClassificationData_by_Reference().
TPSAP::CLASS::getObjectClassification | args | ||
Retrieves detailed information about an existing SAP object classification using the BAPI BAPI_OBJCL_GETCLASSES.
Sample code sequence
References TPSAP::getLoginLanguageISO(), TPSAP::getSessionLogChannel(), and tpco_scanHEX16().
Referenced by setClassification_by_Reference(), and TPSAP::MM::setClassificationData_by_Reference().
TPSAP::CLASS::getSuperClassAllocs | ClassNum ClassType KeyDate ?blnWithDescription? | ||
Class Hierarchy BAPI: (Directly) Superior Classes This BAPI returns the superior classes directly above a class in a class hierarchy. The initial class must be transferred in field 'ClassNum', and the class type in field 'ClassType'. You can transfer a date ('KeyDate'). Output table 'SuperclassesList' contains the names of the superior classes ('ClassName') and the class type again. If the BAPI runs succesfully, table Return contains no messages of type 'E'.
The result contains the superior classes immediatly above the class, but not their superior classes.
Important: This function required the T4S JCO connector.
ClassNum | - Class |
ClassType | - Class Type |
KeyDate | - Valid-From Date |
blnWithDescription | - Determine language dependent Description - (optional - default TRUE) |
References TPSAP::getSessionLogChannel(), TPSAP::performSapCall(), and tpco_scanHEX16().
TPSAP::CLASS::initClassificationStructureChange | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section Class:PARAMETER.
args | none |
References TPSAP::getSessionLogChannel().
TPSAP::CLASS::initClassificationStructureCreate | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section Class:PARAMETER.
args | none |
References TPSAP::getSessionLogChannel().
TPSAP::CLASS::initObjectClassificationStructure | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification.
args | none |
References clearObjectClassificationCurrency(), clearObjectClassificationNumericValues(), clearObjectClassificationStringValues(), and TPSAP::getSessionLogChannel().
Referenced by selectClassificationDefinition().
TPSAP::CLASS::mergeObjectClassification | args | ||
This function merges the result of the TPSAP::CLASS::getDetailedObjectClassification call with the new object classification defined by the mapping. It will copy all current values in SAP that are not specified by the mapping to the internal buffer that is used to update the object classification. This will avoid that not specified calcification values are deleted during the update via the BAPI_OBJCL_CHANGE function in SAP.
More details can be found in the SAP OSS-Note: 922075 (BAPI_OBJCL_CHANGE - Char value assignments disappear)
Sample code sequence
References TPSAP::getSessionLogChannel().
TPSAP::CLASS::selectChangeMasterClassification | ChangeNumber args | ||
Stores the given SAP change master id into the global TCL ::SAPDat array for a future transfer.
ChangeNumber | |
args | none |
References TPSAP::ECM::getInternalChangeNumber(), and TPSAP::getSessionLogChannel().
TPSAP::CLASS::selectClassificationDefinition | ClassNumber ClassType KeyDate ChangeNumber StdClass Status args | ||
Stores the given SAP class params into the global TCL ::SAPDat array for a future transfer.
ClassNumber | |
ClassType | |
KeyDate | |
ChangeNumber | |
StdClass | |
Status | |
args | none |
References TPSAP::getSessionLogChannel(), and initObjectClassificationStructure().
Referenced by setClassification_by_Reference(), and TPSAP::MM::setClassificationData_by_Reference().
TPSAP::CLASS::selectDocumentClassification | DocumentNumber DocumentType DocumentPart DocumentVersion args | ||
Stores the given SAP document info record object key into the global TCL ::SAPDat array for a future transfer.
DocumentNumber | |
DocumentType | |
DocumentPart | |
DocumentVersion | |
args | none |
References TPSAP::DIR::getInternalDocumentNumber(), and TPSAP::getSessionLogChannel().
TPSAP::CLASS::selectDocumentObjectLinkClassification | LinkNumber args | ||
Stores the given SAP document object link object key into the global TCL ::SAPDat array for a future transfer.
LinkNumber | |
args | none |
References TPSAP::getSessionLogChannel().
TPSAP::CLASS::selectGenericObjectLinkClassification | ObjectKey ObjectTable args | ||
Stores the given SAP object key and the object table into the global TCL ::SAPDat array for a future transfer. This function enables T4S to maintain generic object classifications.
ObjectKey | (Internal SAP object number based on the given ObjectTable) |
ObjectTable | (ObjectTable defining the given ObjectKey -> CRVS_B = PRT, EQUI = Equipment, MARA = MaterialMaster, DRAD = Object Link, DRAW = DIR, AENR = ChangeNo, PLKO = RoutingHeader, ...) |
args | none |
References TPSAP::getSessionLogChannel().
TPSAP::CLASS::selectMaterialMasterClassification | MaterialNumber args | ||
Stores the given SAP material master id into the global TCL ::SAPDat array for a future transfer.
MaterialNumber | |
args | none |
References TPSAP::MM::getInternalMaterialNumber(), and TPSAP::getSessionLogChannel().
Referenced by setClassification_by_Reference(), and TPSAP::MM::setClassificationData_by_Reference().
TPSAP::CLASS::selectPlanClassification | PlanType GroupId GroupCounter args | ||
Stores the given SAP routing object key into the global TCL ::SAPDat array for a future transfer.
PlanType | |
GroupId | |
GroupCounter | |
args | none |
References TPSAP::getSessionLogChannel().
TPSAP::CLASS::setClassification_by_Reference | ObjectKey TargetObjectKey args | ||
Used to create a MM object classification based on an existing SAP MM object classification.
ObjectKey | |
TargetObjectKey | |
args | none |
References getDetailedObjectClassification(), TPSAP::MM::getInternalMaterialNumber(), getObjectClassification(), T4X::CORE::getSessionLogChannel(), TPSAP::getSessionLogChannel(), selectClassificationDefinition(), selectMaterialMasterClassification(), T4S::storeObjectClassification2MultiTransferCache(), storeObjectClassificationStringValue(), and tpwrite().
TPSAP::CLASS::storeObjectClassificationCurrency | Index CHARACT VALUE_FROM VALUE_TO VALUE_RELATION CURRENCY_FROM_ISO CURRENCY_TO_ISO INHERITED INSTANCE CHARACT_DESCR args | ||
Sets the input structure for the ALLOCVALUESCURR->Classification BAPI for a future transfer - Values of Type CURR.
Index | - internal TCL array index |
CHARACT | |
VALUE_FROM | |
VALUE_TO | |
VALUE_RELATION | |
CURRENCY_FROM_ISO | |
CURRENCY_TO_ISO | |
INHERITED | |
INSTANCE | |
CHARACT_DESCR | |
args | none |
References TPSAP::getSessionLogChannel().
TPSAP::CLASS::storeObjectClassificationNumericValue | Index CHARACT VALUE_FROM VALUE_TO VALUE_RELATION UNIT_FROM_ISO UNIT_TO_ISO INHERITED INSTANCE CHARACT_DESCR args | ||
Sets the input structure for the Classification BAPI for a future transfer - Values of Type NUM, DATE, TIME.
Index | - internal TCL array index |
CHARACT | |
VALUE_FROM | |
VALUE_TO | |
VALUE_RELATION | It is possible to define ranges, where the FROM or TO value is coded with a special operator. |
Example: 1,54>-<2,088
All possible coding's are listed below:
Code | Operator | Value1 | Operator | Value2 |
---|---|---|---|---|
1 | EQ | Value1 | ||
2 | GE | Value1 | LT | Value2 |
3 | GE | Value1 | LE | Value2 |
4 | GT | Value1 | LT | Value2 |
5 | GT | Value1 | LE | Value2 |
6 | LT | Value1 | ||
7 | LE | Value1 | ||
8 | GT | Value1 | ||
9 | GE | Value1 |
UNIT_FROM_ISO | |
UNIT_TO_ISO | |
INHERITED | |
INSTANCE | |
CHARACT_DESCR | |
args | none |
References TPSAP::getSessionLogChannel().
TPSAP::CLASS::storeObjectClassificationStringValue | Index CHARACT VALUE_CHAR INHERITED INSTANCE VALUE_NEUTRAL CHARACT_DESCR args | ||
Sets the input structure for the Classification BAPI for a future transfer - Values of Type CHAR, BOOL.
Index | - internal TCL array index |
CHARACT | |
VALUE_CHAR | |
INHERITED | |
INSTANCE | |
VALUE_NEUTRAL | |
CHARACT_DESCR | |
arsg | none |
References TPSAP::getSessionLogChannel().
Referenced by setClassification_by_Reference(), and TPSAP::MM::setClassificationData_by_Reference().