![]() |
T4S4
19.1 C8540 A23673
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... | |
deleteObjectClassification args | |
Deletes an existing SAP object classification using the BAPI BAPI_OBJCL_DELETE. 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 successfully, 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 | |
Stores the given SAP Change Master id into the global TCL ::SAPDat array for a future Change Master classification transaction. More... | |
selectClassificationDefinition ClassNumber ClassType KeyDate ChangeNumber StdClass Status | |
Stores the given SAP class params into the global TCL ::SAPDat array for a future object classification transaction. More... | |
selectDocumentClassification DocumentNumber DocumentType DocumentPart DocumentVersion | |
Stores the given SAP document info record object key into the global TCL ::SAPDat array for a future Document Info Record classification transaction. More... | |
selectDocumentObjectLinkClassification LinkNumber | |
Stores the given SAP Document Object Link object key into the global TCL ::SAPDat array for a future Document Object Link classification transaction. More... | |
selectGenericObjectLinkClassification ObjectKey ObjectTable | |
Stores the given SAP generic 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 | |
Stores the given SAP material master id into the global TCL ::SAPDat array for a future Material Master classification transaction. More... | |
selectPlanClassification PlanType GroupId GroupCounter | |
Stores the given SAP Routing Identifier into the global TCL ::SAPDat array for a future Routing classification transaction. More... | |
setClassification_by_Reference SourceMaterialMaster TargetMaterialMaster args | |
Used to copy the data of an existing material master object classification to the actual transferred material. More... | |
storeObjectClassificationCurrency Index CHARACT VALUE_FROM VALUE_TO VALUE_RELATION CURRENCY_FROM_ISO CURRENCY_TO_ISO INHERITED INSTANCE CHARACT_DESCR | |
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 | |
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 | |
Sets the input structure for the Classification BAPI for a future transfer - Values of Type CHAR, BOOL. More... | |
storeObjectClassificationStringValue2 Index CHARACT VALUE_CHAR INHERITED INSTANCE VALUE_NEUTRAL CHARACT_DESCR VALUE_CHAR_LONG VALUE_NEUTRAL_LONG | |
Sets the input structure ALLOCVALUESCHAR 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 |
TPSAP::CLASS::charactGetDetail | args | ||
Retrieves detailed information of an existing SAP characteristic object.
Sample code sequence
TPSAP::CLASS::classGetDetail | args | ||
Retrieves detailed information of an existing SAP class definition.
Sample code sequence
TPSAP::CLASS::clearObjectClassificationCurrency | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification:CharacteristicCurrValues.
args | none |
TPSAP::CLASS::clearObjectClassificationNumericValues | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification:CharacteristicNumericValues.
args | none |
TPSAP::CLASS::clearObjectClassificationStringValues | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification:CharacteristicStringValues.
args | none |
TPSAP::CLASS::deleteObjectClassification | args | ||
Deletes an existing SAP object classification using the BAPI BAPI_OBJCL_DELETE.
Sample code sequence
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
TPSAP::CLASS::getDetailedObjectClassification | args | ||
Retrieves detailed information about an existing SAP object classification using the BAPI BAPI_OBJCL_GETDETAIL.
Sample code sequence
TPSAP::CLASS::getObjectClassification | args | ||
Retrieves detailed information about an existing SAP object classification using the BAPI BAPI_OBJCL_GETCLASSES.
Sample code sequence
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 successfully, table Return contains no messages of type 'E'.
The result contains the superior classes immediately 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) |
TPSAP::CLASS::initClassificationStructureChange | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section Class:PARAMETER.
args | none |
TPSAP::CLASS::initClassificationStructureCreate | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section Class:PARAMETER.
args | none |
TPSAP::CLASS::initObjectClassificationStructure | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section ObjectClassification.
args | none |
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
TPSAP::CLASS::selectChangeMasterClassification | ChangeNumber | ||
Stores the given SAP Change Master id into the global TCL ::SAPDat array for a future Change Master classification transaction.
ChangeNumber | Change Number |
TPSAP::CLASS::selectClassificationDefinition | ClassNumber ClassType KeyDate ChangeNumber StdClass Status | ||
Stores the given SAP class params into the global TCL ::SAPDat array for a future object classification transaction.
ClassNumber | Class Number |
ClassType | Class Type |
KeyDate | Validity Time in the SAP internal format |
ChangeNumber | Change Number |
StdClass | Indicator: Standard Class |
Status | Classification Status |
TPSAP::CLASS::selectDocumentClassification | DocumentNumber DocumentType DocumentPart DocumentVersion | ||
Stores the given SAP document info record object key into the global TCL ::SAPDat array for a future Document Info Record classification transaction.
DocumentNumber | Document Number |
DocumentType | Document Type |
DocumentPart | Document Part |
DocumentVersion | Document Version |
TPSAP::CLASS::selectDocumentObjectLinkClassification | LinkNumber | ||
Stores the given SAP Document Object Link object key into the global TCL ::SAPDat array for a future Document Object Link classification transaction.
LinkNumber |
TPSAP::CLASS::selectGenericObjectLinkClassification | ObjectKey ObjectTable | ||
Stores the given SAP generic 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, ...) |
TPSAP::CLASS::selectMaterialMasterClassification | MaterialNumber | ||
Stores the given SAP material master id into the global TCL ::SAPDat array for a future Material Master classification transaction.
MaterialNumber | Material Number |
TPSAP::CLASS::selectPlanClassification | PlanType GroupId GroupCounter | ||
Stores the given SAP Routing Identifier into the global TCL ::SAPDat array for a future Routing classification transaction.
PlanType | Plan Type |
GroupId | Plan Group Id |
GroupCounter | Plan Group Counter |
TPSAP::CLASS::setClassification_by_Reference | SourceMaterialMaster TargetMaterialMaster args | ||
Used to copy the data of an existing material master object classification to the actual transferred material.
SourceMaterialMaster | The source material from which the classification will be copied from. |
TargetMaterialMaster | The target material to which the classification will be copied to. |
args | (not used) |
TPSAP::CLASS::storeObjectClassificationCurrency | Index CHARACT VALUE_FROM VALUE_TO VALUE_RELATION CURRENCY_FROM_ISO CURRENCY_TO_ISO INHERITED INSTANCE CHARACT_DESCR | ||
Sets the input structure for the ALLOCVALUESCURR->Classification BAPI for a future transfer - Values of Type CURR.
Index | internal TCL array index |
CHARACT | Characteristic Name |
VALUE_FROM | Internal floating point value from |
VALUE_TO | Internal floating point value to |
VALUE_RELATION | Code for value dependency/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 |
CURRENCY_FROM_ISO | ISO Currency Code for value from |
CURRENCY_TO_ISO | Currency Code for value to |
INHERITED | Indicator: characteristic is inherited |
INSTANCE | Instance counter |
CHARACT_DESCR | Characteristic description |
TPSAP::CLASS::storeObjectClassificationNumericValue | Index CHARACT VALUE_FROM VALUE_TO VALUE_RELATION UNIT_FROM_ISO UNIT_TO_ISO INHERITED INSTANCE CHARACT_DESCR | ||
Sets the input structure for the Classification BAPI for a future transfer - Values of Type NUM, DATE, TIME.
Index | internal TCL array index |
CHARACT | Characteristic Name |
VALUE_FROM | Internal floating point value from |
VALUE_TO | Internal floating point value to |
VALUE_RELATION | Code for value dependency/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 | Base unit of measure in ISO code for value from |
UNIT_TO_ISO | Base unit of measure in ISO code for value to |
INHERITED | Indicator: characteristic is inherited |
INSTANCE | Instance counter |
CHARACT_DESCR | Characteristic description |
TPSAP::CLASS::storeObjectClassificationStringValue | Index CHARACT VALUE_CHAR INHERITED INSTANCE VALUE_NEUTRAL CHARACT_DESCR | ||
Sets the input structure for the Classification BAPI for a future transfer - Values of Type CHAR, BOOL.
Index | - internal TCL array index |
CHARACT | Characteristic Name |
VALUE_CHAR | Characteristic Value |
INHERITED | Indicator: characteristic is inherited |
INSTANCE | Instance counter |
VALUE_NEUTRAL | Neutral Characteristic Value |
CHARACT_DESCR | Characteristic description |
TPSAP::CLASS::storeObjectClassificationStringValue2 | Index CHARACT VALUE_CHAR INHERITED INSTANCE VALUE_NEUTRAL CHARACT_DESCR VALUE_CHAR_LONG VALUE_NEUTRAL_LONG | ||
Sets the input structure ALLOCVALUESCHAR for the Classification BAPI for a future transfer - Values of Type CHAR, BOOL.
Index | internal TCL array index |
CHARACT | Characteristic Name |
VALUE_CHAR | Characteristic Value |
INHERITED | Indicator: characteristic is inherited |
INSTANCE | Instance counter |
VALUE_NEUTRAL | Neutral Characteristic Value |
CHARACT_DESCR | Characteristic description |
VALUE_CHAR_LONG | Characteristic Value (long version with up to 70 characters) |
VALUE_NEUTRAL_LONG | Neutral Characteristic Value (long version with up to 70 characters) |