![]() |
T4S4
18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
call_TESISPLM_ECM_GET_ECM4OBJECT args | |
Calls SAP function '/TESISPLM/ECM_GET_ECM4OBJECT'. More... | |
call_TESISPLM_ECM_OBJMGREC_READ args | |
Calls SAP function '/TESISPLM/ECM_OBJMGREC_READ'. More... | |
call_TESISPLM_ECM_OBJTYPE_DEF_READ args | |
Calls SAP function '/TESISPLM/ECM_OBJTYPE_DEF_READ'. More... | |
call_TESISPLM_ECM_PROFILE_READ args | |
Calls SAP function '/TESISPLM/ECM_PROFILE_READ'. More... | |
ChangeMasterAssignObject2AltDate args | |
Assigns an existing object to an existing alternate date for a given ECM in SAP. Pls check the SAP BAPI "CCAP_ASSIGN_OBJECT_TO_ALT_DATE" for more information. More... | |
ChangeMasterChangeAltDate args | |
Changes an existing alternate date for a given ECM in SAP. More... | |
ChangeMasterCreateAltDate args | |
Creates an alternate date for a given ECM in SAP. More... | |
ChangeMasterDeleteAltDate args | |
Deletes an existing alternate date for a given ECM in SAP. More... | |
createChangeMaster_WithProfile strDescription strProfile strDate args | |
This function creates an ECM with ECM profile The OOTB SAP BAPI cannot handle ECM profile To achieve this functionality, the T4S call transaction mechanism is used. Therefore it is necessary to implement the T4S call transaction ABAP as well. More... | |
getChangeMaster4Object strSapObjectKey ?intSapObjectType? ?strSapObjectId? | |
Gets all ECMs attached to a given object. More... | |
getChangeMasterAltDatesList ChangeMaster args | |
Returns a list (internal format) of all alt dates attached to the given ChangeMaster. More... | |
getChangeMasterEffectivity ChangeMaster args | |
Returns the effectivity (internal format) fora given ECM. More... | |
getChangeMasterInfo ChangeNumber ?ReadOBJMGREC? ?ReadAltDates? ?ReadEffectivity? ?ReadMaintVariant? args | |
Retrieves detailed SAP change master information. More... | |
getChangeMasterLongText ChangeNo ?Language? args | |
Retrieves the SAP long text for a given ECM. More... | |
getChangeMasterMultipleHeaders ?ListOfChangeNumbers? | |
Retrieves the ChangeMaster header data for a given list of change numbers or all change numbers. More... | |
getChangeMasterObjectTypeDefinition ?Language? args | |
Returns the definition for all existing ECM object types including the ID and the name. More... | |
getChangeMasterObjMgRecList ChangeMaster args | |
Returns a list (internal format) of all objects attached to the given ChangeMaster. More... | |
getChangeMasterProfileData ChangeMasterProfile ?Language? args | |
Returns all settings for a given ECM Change Master Profile. More... | |
getChangeMasterValueAssign ChangeMaster args | |
Returns the value assign (=maintenance variant) data (internal format) for a given ECM. More... | |
getExternalChangeNumber InternalNumber args | |
Retrieves the SAP external change master id for a given SAP internal change master id. More... | |
getInternalChangeNumber ExternalNumber args | |
Retrieves the SAP internal change master id for a given SAP external change master id. More... | |
getObjectManagementTypesList args | |
initSAPChangeMasterStructure args | |
Resets part of the corresponding global TCL ::SAPDat array within the section ChangeMaster. More... | |
RevisionLevelSelect args | |
Returns a specific revision levels by date for a material master or DIR. More... | |
RevisionLevelTableExport args | |
Returns all revision levels for a material master or document info record. More... | |
setObjectTypeStructure ObjectType ?ACTIVE? ?LOCKED? ?OBJ_REQU? ?MGTREC_GEN? ?GEN_NEW? ?GEN_DIALOG? | |
Define the object types for the ECM creation/update structure to enable the modification of objects with the actual change object. More... | |
setRevisionLevel Mode ObjectId ChangeNumber RevisionLevel args | |
Sets the revision level for a given material master or document info record object using the provided change master object via the CCAP_REV_LEVEL_MAINTAIN function module. More... | |
storeLongText4Description Description ?TEXTKEY? ?TDNAME? ?TDID? ?TDSPRAS? | |
Stores the given ChangeMaster description as a SAP long text if its length a greater than 40 chars in the global TCL ::SAPDat array for a future transfer. More... | |
updateObjectManagementRecord strChangeNumber strObjectDescription ChangeTypeObject strObjectType ObjectId ?DeletetionFlag? args | |
Adds, deletes or changes (description) an affected item record for the given object (e.g. MM) to the given ECM in SAP. More... | |
updateObjectManagementRecord2 strChangeNumber strObjectDescription ChangeTypeObject strObjectType ObjectId ?DeletetionFlag? args | |
This call is similar to updateObjectManagementRecord but will convert the affected item number to the internal format before calling SAP. More... | |
TPSAP::ECM::call_TESISPLM_ECM_GET_ECM4OBJECT | args | ||
Calls SAP function '/TESISPLM/ECM_GET_ECM4OBJECT'.
References TPSAP::performSapCall().
TPSAP::ECM::call_TESISPLM_ECM_OBJMGREC_READ | args | ||
Calls SAP function '/TESISPLM/ECM_OBJMGREC_READ'.
References TPSAP::performSapCall().
TPSAP::ECM::call_TESISPLM_ECM_OBJTYPE_DEF_READ | args | ||
Calls SAP function '/TESISPLM/ECM_OBJTYPE_DEF_READ'.
References TPSAP::performSapCall().
TPSAP::ECM::call_TESISPLM_ECM_PROFILE_READ | args | ||
Calls SAP function '/TESISPLM/ECM_PROFILE_READ'.
References TPSAP::performSapCall().
TPSAP::ECM::ChangeMasterAssignObject2AltDate | args | ||
Assigns an existing object to an existing alternate date for a given ECM in SAP. Pls check the SAP BAPI "CCAP_ASSIGN_OBJECT_TO_ALT_DATE" for more information.
References TPSAP::doCommitOrRollBackBasedOnStatus(), getInternalChangeNumber(), and TPSAP::getSessionLogChannel().
TPSAP::ECM::ChangeMasterChangeAltDate | args | ||
Changes an existing alternate date for a given ECM in SAP.
References TPSAP::doCommitOrRollBackBasedOnStatus(), getInternalChangeNumber(), and TPSAP::getSessionLogChannel().
TPSAP::ECM::ChangeMasterCreateAltDate | args | ||
Creates an alternate date for a given ECM in SAP.
References TPSAP::doCommitOrRollBackBasedOnStatus(), getInternalChangeNumber(), and TPSAP::getSessionLogChannel().
TPSAP::ECM::ChangeMasterDeleteAltDate | args | ||
Deletes an existing alternate date for a given ECM in SAP.
References TPSAP::doCommitOrRollBackBasedOnStatus(), getInternalChangeNumber(), and TPSAP::getSessionLogChannel().
TPSAP::ECM::createChangeMaster_WithProfile | strDescription strProfile strDate args | ||
This function creates an ECM with ECM profile The OOTB SAP BAPI cannot handle ECM profile To achieve this functionality, the T4S call transaction mechanism is used. Therefore it is necessary to implement the T4S call transaction ABAP as well.
References TPSAP::CALL_TRANSACTION::call_transaction(), and TPSAP::getSessionLogChannel().
TPSAP::ECM::getChangeMaster4Object | strSapObjectKey ?intSapObjectType? ?strSapObjectId? | ||
Gets all ECMs attached to a given object.
strSapObjectKey | - SAP object number (eg. 00000000000001870410002 for a Material BOM; 000000000000018704 = int MatNr, 1000 = Plant, 2 = BOM Usage) Important: Internal/External object key can cause a different result |
strSapObjectId | - Internal SAP object id (eg. M00006956 for a Material BOM; M = MaterialBOM, 00006956 = STLNR) - optional - default: Empty Important: Internal/External object key can cause a different result |
intSapObjectType | - 2 digit code specifing the object type (optional - default: 00): 00 -> All Object Types 02 -> Material BOM 03 -> Equipment BOM 04 -> Document Structure 05 -> Functional Location BOM 06 -> Standard BOM 07 -> Order BOM 08 -> WBS BOM 12 -> Routing 13 -> Reference Operation Set 21 -> Inspection Plan 22 -> General Task List 23 -> Equipment Task List 24 -> Master Recipe 25 -> Rate Routing 26 -> Reference Rate Routing 27 -> Functional Location Task List 31 -> Document 41 -> Material 51 -> Characteristic 52 -> Characteristics of Class 53 -> Classification 54 -> Object Dependencies 55 -> Configuration Profile 60 -> Specification 61 -> Phrase 62 -> Dangerous Goods 63 -> Variant Table 66 -> Validity of Material Version 71 -> PVS Variant 72 -> iPPE Process Structure Mode 73 -> PVS Dependency 75 -> Recipe Managemnt 77 -> Work area 79 -> Haz. Subs. |
References TPSAP::getSessionLogChannel().
TPSAP::ECM::getChangeMasterAltDatesList | ChangeMaster args | ||
Returns a list (internal format) of all alt dates attached to the given ChangeMaster.
ChangeMaster | |
args | none |
References getExternalChangeNumber(), getInternalChangeNumber(), and TPSAP::getSessionLogChannel().
Referenced by getChangeMasterInfo().
TPSAP::ECM::getChangeMasterEffectivity | ChangeMaster args | ||
Returns the effectivity (internal format) fora given ECM.
ChangeMaster | |
args | none |
References getExternalChangeNumber(), getInternalChangeNumber(), and TPSAP::getSessionLogChannel().
Referenced by getChangeMasterInfo().
TPSAP::ECM::getChangeMasterInfo | ChangeNumber ?ReadOBJMGREC? ?ReadAltDates? ?ReadEffectivity? ?ReadMaintVariant? args | ||
Retrieves detailed SAP change master information.
ChangeNumber | Change number |
ReadOBJMGREC | - If set to true, a list (internal format) of all objects attached to the given ChangeMaster will be retrieved as well |
ReadAltDates | - If set to true, a list (internal format) of all alt dates attached to the given ChangeMaster will be retrieved as well |
ReadEffectivity | - If set to true, a list (internal format) of the effectivity attached to the given ChangeMaster will be retrieved as well |
ReadMaintVariant | - If set to true, the (internal format) maintenance variant record attached to the given ChangeMaster will be retrieved as well |
args | none |
References getChangeMasterAltDatesList(), getChangeMasterEffectivity(), getChangeMasterObjMgRecList(), getChangeMasterValueAssign(), getInternalChangeNumber(), and TPSAP::getSessionLogChannel().
Referenced by T4S::PROP::CUSTOM::MAPPING::GetECMData().
TPSAP::ECM::getChangeMasterLongText | ChangeNo ?Language? args | ||
Retrieves the SAP long text for a given ECM.
ChangeNo | Change number |
Language | One-character representation of the language |
args | none |
References TPSAP::getSessionLogChannel().
TPSAP::ECM::getChangeMasterMultipleHeaders | ?ListOfChangeNumbers? | ||
Retrieves the ChangeMaster header data for a given list of change numbers or all change numbers.
ListOfChangeNumbers | Optional parameter containing the list of Change numbers that are used to get the corresponding header information. If not specified the system will return all existing change number header information. No wild cards are allowed/supported in the list. |
TPSAP::ECM::getChangeMasterObjectTypeDefinition | ?Language? args | ||
Returns the definition for all existing ECM object types including the ID and the name.
Language | - Optional - Default: EN |
args | none |
References TPSAP::getSessionLogChannel().
TPSAP::ECM::getChangeMasterObjMgRecList | ChangeMaster args | ||
Returns a list (internal format) of all objects attached to the given ChangeMaster.
ChangeMaster | |
args | none |
References getExternalChangeNumber(), getInternalChangeNumber(), and TPSAP::getSessionLogChannel().
Referenced by getChangeMasterInfo().
TPSAP::ECM::getChangeMasterProfileData | ChangeMasterProfile ?Language? args | ||
Returns all settings for a given ECM Change Master Profile.
ChangeMasterProfile | |
Language | - Optional - Default: EN |
args | none |
References TPSAP::getSessionLogChannel().
TPSAP::ECM::getChangeMasterValueAssign | ChangeMaster args | ||
Returns the value assign (=maintenance variant) data (internal format) for a given ECM.
ChangeMaster | |
args | none |
References getExternalChangeNumber(), getInternalChangeNumber(), and TPSAP::getSessionLogChannel().
Referenced by getChangeMasterInfo().
TPSAP::ECM::getExternalChangeNumber | InternalNumber args | ||
Retrieves the SAP external change master id for a given SAP internal change master id.
InternalNumber | SAP internal change master id |
args | none |
References T4X::CORE::getSessionLogChannel(), TPSAP::getSessionLogChannel(), tpco_scanHEX16(), and tpwrite().
Referenced by getChangeMasterAltDatesList(), getChangeMasterEffectivity(), getChangeMasterObjMgRecList(), getChangeMasterValueAssign(), and updateObjectManagementRecord().
TPSAP::ECM::getInternalChangeNumber | ExternalNumber args | ||
Retrieves the SAP internal change master id for a given SAP external change master id.
ExternalNumber | SAP external change master id |
args | none |
References T4X::CORE::getSessionLogChannel(), TPSAP::getSessionLogChannel(), tpco_scanHEX16(), and tpwrite().
Referenced by ChangeMasterAssignObject2AltDate(), ChangeMasterChangeAltDate(), ChangeMasterCreateAltDate(), ChangeMasterDeleteAltDate(), getChangeMasterAltDatesList(), getChangeMasterEffectivity(), getChangeMasterInfo(), getChangeMasterObjMgRecList(), getChangeMasterValueAssign(), TPSAP::CLASS::selectChangeMasterClassification(), setRevisionLevel(), and T4S::ECM::CUSTOM::MAPPING::TC_Object2SAP_ChangeMaster().
TPSAP::ECM::getObjectManagementTypesList | args | ||
TPSAP::ECM::initSAPChangeMasterStructure | args | ||
Resets part of the corresponding global TCL ::SAPDat array within the section ChangeMaster.
args | none |
References TPSAP::getSessionLogChannel().
TPSAP::ECM::RevisionLevelSelect | args | ||
Returns a specific revision levels by date for a material master or DIR.
All | possible params are transferred via the global ::SAPDat TCL array |
References TPSAP::getSessionLogChannel().
TPSAP::ECM::RevisionLevelTableExport | args | ||
Returns all revision levels for a material master or document info record.
All | possible params are transferred via the global ::SAPDat TCL array |
References TPSAP::getSessionLogChannel().
TPSAP::ECM::setObjectTypeStructure | ObjectType ?ACTIVE? ?LOCKED? ?OBJ_REQU? ?MGTREC_GEN? ?GEN_NEW? ?GEN_DIALOG? | ||
Define the object types for the ECM creation/update structure to enable the modification of objects with the actual change object.
ObjectType | defines object type structure name that controls the enabled object type for change, currently the following types are supported:
|
ACTIVE | (optional - default X ) |
LOCKED | (optional - empty) |
OBJ_REQU | (optional - default X) |
MGTREC_GEN | (optional - default X) |
GEN_NEW | (optional - empty) |
GEN_DIALOG | (optional - empty) |
References TPSAP::getSessionLogChannel(), and tpwrite().
TPSAP::ECM::setRevisionLevel | Mode ObjectId ChangeNumber RevisionLevel args | ||
Sets the revision level for a given material master or document info record object using the provided change master object via the CCAP_REV_LEVEL_MAINTAIN function module.
Mode | 'MaterialMaster' or 'Document' |
ObjectId | Id of the SAP object for which the revision level should be set. Depends on the param 'Mode' |
ChangeNumber | Used SAP change master object to set the revision level |
RevisionLevel | Revision level to be set |
args | none |
References getInternalChangeNumber(), TPSAP::DIR::getInternalDocumentNumber(), TPSAP::MM::getInternalMaterialNumber(), and TPSAP::getSessionLogChannel().
TPSAP::ECM::storeLongText4Description | Description ?TEXTKEY? ?TDNAME? ?TDID? ?TDSPRAS? | ||
Stores the given ChangeMaster description as a SAP long text if its length a greater than 40 chars in the global TCL ::SAPDat array for a future transfer.
Description | |
TEXTKEY | (optional - empty) |
TDNAME | (optional - empty) |
TDID | (optional - empty) |
TDSPRAS | (optional - empty) |
References TPSAP::getLoginLanguage(), and TPSAP::getSessionLogChannel().
Referenced by updateObjectManagementRecord().
TPSAP::ECM::updateObjectManagementRecord | strChangeNumber strObjectDescription ChangeTypeObject strObjectType ObjectId ?DeletetionFlag? args | ||
Adds, deletes or changes (description) an affected item record for the given object (e.g. MM) to the given ECM in SAP.
strChangeNumber | -> ChangeNumber |
strObjectDescription | -> new description for an existing afffected item |
ChangeTypeObject | -> ChangeTypeObject (usually 00000) |
strObjectType | -> Type of affected item -> Material | Document | BillOfMaterial | Plan |
ObjectId | -> Depending on the opject type, the following parameters have to be passed in as a TCL list: strObjectType == Material -> ObjectId = MaterialNumber strObjectType == Document -> ObjectId = DocumentNumber DocumentType DocumentPart DocumentVersion strObjectType == BillOfMaterial -> ObjectId = MaterialNumber BomCat (M|E|S|P|K) BomUsage ?Plant? ?PSP-Element (for ProjectBOM)? ?Order (for OrderBOM)? ?OrderPosition (for OrderBOM)? strObjectType == Plan -> ObjectId = TaskType TaskGroup |
DeletetionFlag | -> Optional - Default: Empty - If set to X, the record assignment will be deleted in SAP. |
References getExternalChangeNumber(), TPSAP::DIR::getExternalDocumentNumber(), TPSAP::MM::getExternalMaterialNumber(), TPSAP::PROJECT::getExternalPSPNR(), TPSAP::DIR::getInternalDocumentNumber(), TPSAP::MM::getInternalMaterialNumber(), TPSAP::getSessionLogChannel(), storeLongText4Description(), tpco_scanHEX16(), and tpwrite().
Referenced by updateObjectManagementRecord2().
TPSAP::ECM::updateObjectManagementRecord2 | strChangeNumber strObjectDescription ChangeTypeObject strObjectType ObjectId ?DeletetionFlag? args | ||
This call is similar to updateObjectManagementRecord but will convert the affected item number to the internal format before calling SAP.
strChangeNumber | -> ChangeNumber |
strObjectDescription | -> new description for an existing afffected item |
ChangeTypeObject | -> ChangeTypeObject (usually 00000) |
strObjectType | -> Type of affected item -> Material | Document | BillOfMaterial | Plan |
ObjectId | -> Depending on the opject type, the following parameters have to be passed in as a TCL list: strObjectType == Material -> ObjectId = MaterialNumber strObjectType == Document -> ObjectId = DocumentNumber DocumentType DocumentPart DocumentVersion strObjectType == BillOfMaterial -> ObjectId = MaterialNumber BomCat (M|E|S|P|K) BomUsage ?Plant? ?PSP-Element (for ProjectBOM)? ?Order (for OrderBOM)? ?OrderPosition (for OrderBOM)? strObjectType == Plan -> ObjectId = TaskType TaskGroup |
DeletetionFlag | -> Optional - Default: Empty - If set to X, the record assignment will be deleted in SAP. |
References TPSAP::getSessionLogChannel(), and updateObjectManagementRecord().