![]() |
T4S4
19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
checkOutView args | |
This function uses the function module BAPI_DOCUMENT_CHECKOUTVIEW2 to check out originals of SAP a document info record and if requested available document structures for reading. The functionality of the call is controlled by setting the following SAPDat array parameters: More... | |
copyObjectLinks SourceDocumentNumber SourceDocumentType SourceDocumentPart SourceDocumentVersion TargetDocumentNumber TargetDocumentType TargetDocumentPart TargetDocumentVersion ?TypesToIgnore? ?DeleteExistingLinks? | |
Copies all object links from one document to another existing document. More... | |
ExistenceCheck DocumentNumber DocumentType DocumentPart DocumentVersion args | |
Checks, if a document info record exists in SAP. More... | |
getActiveVersion DocumentNumber DocumentType DocumentPart args | |
Retrieves the latest version of a SAP document info record object. More... | |
getActualVersion DocumentNumber DocumentType DocumentPart DocumentVersion Date ?ReleaseOnly? | |
This function determines the current and valid version of a document info record. More... | |
getDataCarrierInfo DataCarrierName HostName ?SapSystem? ?SapClient? args | |
Retrieves detailed information about a SAP data carrier. More... | |
getDocumentInfoRecordInfo DocumentNumber DocumentType DocumentPart DocumentVersion ?GetActiveFileFlag? ?GetComponentsFlag? ?GetLongTextsFlag? ?GetObjectLinksFlag? ?GetStatusLogFlag? ?GetStructureFlag? ?GetClassificationFlag? | |
Retrieves SAP document info record information. More... | |
getDocumentInfoRecordList args | |
Matchcode search for document info records in SAP. The input data for this call is transported using the global TCL array ::SAPDat and the array pattern DocumentSelection. The input parameter MAXROWS defaults to "100" but can be adjusted using ::SAPDat(DocumentSelection:PARAMETER:MAXROWS). . More... | |
getDocumentState DocumentNumber DocumentType DocumentPart DocumentVersion args | |
Retrieves the document state for a given SAP document info record object. More... | |
getDocumentTypeInfo DocumentType ?SapSystem? ?SapClient? args | |
Retrieves detailed information about a SAP document info record type. More... | |
getExternalDocumentNumber InternalNumber | |
Retrieves the SAP external document id for a given SAP internal document id. More... | |
getInternalDocumentNumber ExternalNumber | |
Retrieves the SAP internal document id for a given SAP external document id. More... | |
getLatestVersion DocumentNumber DocumentType DocumentPart args | |
Retrieves the latest version of a SAP document info record object. More... | |
getStatusList DOCUMENTTYPE ?GETSTATUSNETWORK? ?STATUSEXTERN? ?STATUSINTERN? | |
This method determines the features of the status that are defined in Customizing for a document type. These are, for example: More... | |
initSAPDocumentDescription Index args | |
Resets part the corresponding global TCL ::SAPDat array within the section Document. More... | |
initSAPDocumentOriginalStructure FileIndex args | |
Resets part the corresponding global TCL ::SAPDat array within the section Document. More... | |
initSAPDocumentStructure args | |
Resets part the corresponding global TCL ::SAPDat array within the section Document. More... | |
initSAPDocumentStructureStructure Index args | |
Resets part the corresponding global TCL ::SAPDat array within the section Document. More... | |
setDocumentState DocumentNumber DocumentType DocumentPart DocumentVersion ChangeNumber NewState StateReason args | |
Sets the status of a Document Info Record to a new value via the BAPI_DOCUMENT_SETSTATUS Bapi. More... | |
setSAPDocumentDescription Index Language LanguageIso Description ?DeleteValue? ?TextIndicator? args | |
Stores the given SAP document description params into the the global TCL ::SAPDat array for a future transfer. More... | |
setSAPDocumentStructureStructure Index DocumentType DocumentNumber DocumentPart DocumentVersion ?SortString? ?Quantity? ?DeleteValue? args | |
Stores the given SAP document structure params into the the global TCL ::SAPDat array for a future transfer. More... | |
TPSAP::DIR::checkOutView | args | ||
This function uses the function module BAPI_DOCUMENT_CHECKOUTVIEW2 to check out originals of SAP a document info record and if requested available document structures for reading. The functionality of the call is controlled by setting the following SAPDat array parameters:
Sample code for simple configuration mode by setting the following array attributes:
Or be setting the following input array input parameters for a much more detailed control of the function called BAPI_DOCUMENT_CHECKOUTVIEW2 PARAMETER.
Sample of all possible input parameters
args | reserved for future usage |
DOCUMENTFILES->Checked Out Originals.
Sample code sequence
TPSAP::DIR::copyObjectLinks | SourceDocumentNumber SourceDocumentType SourceDocumentPart SourceDocumentVersion TargetDocumentNumber TargetDocumentType TargetDocumentPart TargetDocumentVersion ?TypesToIgnore? ?DeleteExistingLinks? | ||
Copies all object links from one document to another existing document.
SourceDocumentNumber | source document number |
SourceDocumentType | source document type |
SourceDocumentPart | source document part |
SourceDocumentVersion | source document version |
TargetDocumentNumber | target document number |
TargetDocumentType | target document type |
TargetDocumentPart | target document part |
TargetDocumentVersion | target document version |
TypesToIgnore | (optional - empty) comma separated list with document types which should not be copied |
DeleteExistingLinks | (optional - FALSE) - (TRUE/FALSE) -> Flag to control if already existing object links of the target document should be deleted or not |
TPSAP::DIR::ExistenceCheck | DocumentNumber DocumentType DocumentPart DocumentVersion args | ||
Checks, if a document info record exists in SAP.
DocumentNumber | |
DocumentType | |
DocumentPart | |
DocumentVersion | |
args | none |
TPSAP::DIR::getActiveVersion | DocumentNumber DocumentType DocumentPart args | ||
Retrieves the latest version of a SAP document info record object.
DocumentNumber | |
DocumentType | |
DocumentPart | |
args | none |
TPSAP::DIR::getActualVersion | DocumentNumber DocumentType DocumentPart DocumentVersion Date ?ReleaseOnly? | ||
This function determines the current and valid version of a document info record.
DocumentNumber | |
DocumentType | |
DocumentPart | |
DocumentVersion | |
Date | In the internal format (YYYYMMDD) |
ReleaseOnly | Flag to switch whether just the released versions or all the versions should be determined (Default ' '). |
TPSAP::DIR::getDataCarrierInfo | DataCarrierName HostName ?SapSystem? ?SapClient? args | ||
Retrieves detailed information about a SAP data carrier.
DataCarrierName | |
HostName | Computer name of the front end computer that the BAPI was called from |
SapSystem | (optional) SAP system identifcation used in the destination definition of the saprfc.ini if not specified we use the information of the current SAP connection |
SapClient | (optional) SAP client identification (e.g. 800) if not specified we use the information of the current SAP connection |
args | none |
TPSAP::DIR::getDocumentInfoRecordInfo | DocumentNumber DocumentType DocumentPart DocumentVersion ?GetActiveFileFlag? ?GetComponentsFlag? ?GetLongTextsFlag? ?GetObjectLinksFlag? ?GetStatusLogFlag? ?GetStructureFlag? ?GetClassificationFlag? | ||
Retrieves SAP document info record information.
DocumentNumber | |
DocumentType | |
DocumentPart | |
DocumentVersion | |
GetActiveFileFlag | (optional - empty) - ('X' or emtpy) -> Retrieve originals data as well |
GetComponentsFlag | (optional - empty) - ('X' or emtpy) -> Retrieve additional files data as well |
GetLongTextsFlag | (optional - empty) - ('X' or emtpy) -> Retrieve long text data as well |
GetObjectLinksFlag | (optional - empty) - ('X' or emtpy) -> Retrieve object link data as well |
GetStatusLogFlag | (optional - empty) - ('X' or emtpy) -> Retrieve status log data as well |
GetStructureFlag | (optional - empty) - ('X' or emtpy) -> Retrieve document structure data as well |
GetClassificationFlag | (optional - empty) - ('X' or emtpy) -> Retrieve classification (Assignment and Additional Information) data as well |
TPSAP::DIR::getDocumentInfoRecordList | args | ||
Matchcode search for document info records in SAP. The input data for this call is transported using the global TCL array ::SAPDat and the array pattern DocumentSelection. The input parameter MAXROWS defaults to "100" but can be adjusted using ::SAPDat(DocumentSelection:PARAMETER:MAXROWS).
.
Example:
set ::SAPDat(DocumentSelection:PARAMETER:MAXROWS) "200"
set ::SAPDat(DocumentSelection:PARAMETER:CADINDICATOR) "*"
set ::SAPDat(DocumentSelection:PARAMETER:DOCUMENTPART) $DocumentPart
set ::SAPDat(DocumentSelection:PARAMETER:DOCUMENTTYPE) $DocumentType
set ::SAPDat(DocumentSelection:PARAMETER:DOCUMENTVERSION) $DocumentVersion
set ::SAPDat(DocumentSelection:DOCNUMBERSELECTION:SIGN:1) "I"
set ::SAPDat(DocumentSelection:DOCNUMBERSELECTION:OPTION:1) "CP"
set ::SAPDat(DocumentSelection:DOCNUMBERSELECTION:DOCUMENTNUMBER_LOW:1) $DocumentNumber
Wildcards (*) can be used. Please refer to the SAP API documentation for more information about the available input parameters.
args |
TPSAP::DIR::getDocumentState | DocumentNumber DocumentType DocumentPart DocumentVersion args | ||
Retrieves the document state for a given SAP document info record object.
DocumentNumber | |
DocumentType | |
DocumentPart | |
DocumentVersion | |
args | none |
TPSAP::DIR::getDocumentTypeInfo | DocumentType ?SapSystem? ?SapClient? args | ||
Retrieves detailed information about a SAP document info record type.
DocumentType | |
SapSystem | (optional) SAP system identifcation used in the destination definition of the saprfc.ini if not specified we use the information of the current SAP connection |
SapClient | (optional) SAP client identification (e.g. 800) if not specified we use the information of the current SAP connection |
args | none |
TPSAP::DIR::getExternalDocumentNumber | InternalNumber | ||
Retrieves the SAP external document id for a given SAP internal document id.
InternalNumber | SAP internal document id |
TPSAP::DIR::getInternalDocumentNumber | ExternalNumber | ||
Retrieves the SAP internal document id for a given SAP external document id.
ExternalNumber | SAP external document id |
TPSAP::DIR::getLatestVersion | DocumentNumber DocumentType DocumentPart args | ||
Retrieves the latest version of a SAP document info record object.
DocumentNumber | |
DocumentType | |
DocumentPart | |
args | none |
TPSAP::DIR::getStatusList | DOCUMENTTYPE ?GETSTATUSNETWORK? ?STATUSEXTERN? ?STATUSINTERN? | ||
This method determines the features of the status that are defined in Customizing for a document type. These are, for example:
DOCUMENTTYPE | Document Type |
GETSTATUSNETWORK | Determine Valid Successor for Status |
STATUSEXTERN | Document Status (External Abbreviation, language-dependent) |
STATUSINTERN | Document Status (Internal Abbreviation) |
Result Structure
TPSAP::DIR::initSAPDocumentDescription | Index args | ||
Resets part the corresponding global TCL ::SAPDat array within the section Document.
Index | TCL array index |
args | none |
TPSAP::DIR::initSAPDocumentOriginalStructure | FileIndex args | ||
Resets part the corresponding global TCL ::SAPDat array within the section Document.
FileIndex | TCL array index |
args | none |
TPSAP::DIR::initSAPDocumentStructure | args | ||
Resets part the corresponding global TCL ::SAPDat array within the section Document.
args | none |
TPSAP::DIR::initSAPDocumentStructureStructure | Index args | ||
Resets part the corresponding global TCL ::SAPDat array within the section Document.
Index | TCL array index |
args | none |
TPSAP::DIR::setDocumentState | DocumentNumber DocumentType DocumentPart DocumentVersion ChangeNumber NewState StateReason args | ||
Sets the status of a Document Info Record to a new value via the BAPI_DOCUMENT_SETSTATUS Bapi.
DocumentNumber | |
DocumentType | |
DocumentPart | |
DocumentVersion | |
ChangeNumber | Changenumber that define the valid from date of the status change |
NewState | New document status |
StateReason | Reason that will be used in the status log of SAP Document |
args | none |
TPSAP::DIR::setSAPDocumentDescription | Index Language LanguageIso Description ?DeleteValue? ?TextIndicator? args | ||
Stores the given SAP document description params into the the global TCL ::SAPDat array for a future transfer.
Index | -> TCL array index |
Language | |
LanguageIso | |
Description | |
DeleteValue | (optional - empty) |
TextIndicator | (optional - empty) |
args | none |
TPSAP::DIR::setSAPDocumentStructureStructure | Index DocumentType DocumentNumber DocumentPart DocumentVersion ?SortString? ?Quantity? ?DeleteValue? args | ||
Stores the given SAP document structure params into the the global TCL ::SAPDat array for a future transfer.
Index | TCL array index |
DocumentType | |
DocumentNumber | |
DocumentPart | |
DocumentVersion | |
SortString | (optional - empty) |
Quantity | (optional - 1) |
DeleteValue | (optional - empty) |
args | none |