T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
TPSAP::DIR Namespace 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?
 Retrieves the document state net for a given SAP document type. 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...
 

Function Documentation

◆ checkOutView()

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:

1 set ::SAPDat(Document:DocumentKey:DOCUMENTTYPE) "DRW" ; # Document Type of Header Document
2 set ::SAPDat(Document:DocumentKey:DOCUMENTNUMBER) "$MyDirNo" ; # Document Number of Header Document
3 set ::SAPDat(Document:DocumentKey:DOCUMENTPART) "000" ; # Document Part of Header Document
4 set ::SAPDat(Document:DocumentKey:DOCUMENTVERSION) "00" ; # Document Version of Header Document
5 set ::SAPDat(Document:Parameter:ORIGINALPATH) "c:/temp" ; # Path Where You Want to store the checked out Originals
6 # File specific setting
7 set ::SAPDat(Document:DocumentFile:WSAPPLICATION) "PDF" ; # Application
8 set ::SAPDat(Document:DocumentFile:ORIGINALTYPE) "1" ; # Application number
9 set ::SAPDat(Document:DocumentFile:APPLICATION_ID) "" ; # Logical document
10 set ::SAPDat(Document:DocumentFile:FILE_ID) "" ; # Physical document

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

1  set ::SAPDat(Document:PARAMETER:DOCBOMCHANGENUMBER) "" ; # Change number
2  set ::SAPDat(Document:PARAMETER:DOCBOMREVISIONLEVEL) "" ; # Revision level
3  set ::SAPDat(Document:PARAMETER:DOCBOMVALIDFROM) "" ; # Valid-From Date
4  set ::SAPDat(Document:PARAMETER:DOCUMENTNUMBER) "" ; # Document Number of Header Document
5  set ::SAPDat(Document:PARAMETER:DOCUMENTPART) "" ; # Document Part of Header Document
6  set ::SAPDat(Document:PARAMETER:DOCUMENTTYPE) "" ; # Document Type of Header Document
7  set ::SAPDat(Document:PARAMETER:DOCUMENTVERSION) "" ; # Document Version of Header Document
8  set ::SAPDat(Document:PARAMETER:GETCOMPONENTS) "X" ; # Additional Files
9  set ::SAPDat(Document:PARAMETER:GETHEADER) "X" ; # Check out header document
10  set ::SAPDat(Document:PARAMETER:GETSTRUCTURE) "1" ; # Document Hierarchy (Several Variants Possible)
11  set ::SAPDat(Document:PARAMETER:HOSTNAME) " " ; # Name of Front-end
12  set ::SAPDat(Document:PARAMETER:ORIGINALPATH) " " ; # Path Where You Want to Check In Originals
13  set ::SAPDat(Document:PARAMETER:PF_FTP_DEST) " " ; # Logical Destination (Specified in Function Call)
14  set ::SAPDat(Document:PARAMETER:PF_HTTP_DEST) " " ; # Logical Destination (Specified in Function Call)
15 
16 DOCUMENTFILE->Original.
17 set ::SAPDat(Document:DOCUMENTFILE:DELETEVALUE) "" ; # Deletion Indicator
18 set ::SAPDat(Document:DOCUMENTFILE:DOCUMENTTYPE) "" ; # Document Type
19 set ::SAPDat(Document:DOCUMENTFILE:DOCUMENTNUMBER) "" ; # Document number
20 set ::SAPDat(Document:DOCUMENTFILE:DOCUMENTPART) "" ; # Document part
21 set ::SAPDat(Document:DOCUMENTFILE:DOCUMENTVERSION) "" ; # Document version
22 set ::SAPDat(Document:DOCUMENTFILE:ORIGINALTYPE) "" ; # Application number
23 set ::SAPDat(Document:DOCUMENTFILE:SOURCEDATACARRIER) "" ; # Name of Data Carrier
24 set ::SAPDat(Document:DOCUMENTFILE:STORAGECATEGORY) "" ; # Storage category for original files
25 set ::SAPDat(Document:DOCUMENTFILE:WSAPPLICATION) "" ; # Application
26 set ::SAPDat(Document:DOCUMENTFILE:DOCPATH) "" ; # Path for original file
27 set ::SAPDat(Document:DOCUMENTFILE:DOCFILE) "" ; # Original of document
28 set ::SAPDat(Document:DOCUMENTFILE:STATUSINTERN) "" ; # Document Status
29 set ::SAPDat(Document:DOCUMENTFILE:STATUSEXTERN) "" ; # Status of a document (language-dependent)
30 set ::SAPDat(Document:DOCUMENTFILE:STATUSLOG) "" ; # Document management log field
31 set ::SAPDat(Document:DOCUMENTFILE:APPLICATION_ID) "" ; # Logical document
32 set ::SAPDat(Document:DOCUMENTFILE:FILE_ID) "" ; # Physical document
33 set ::SAPDat(Document:DOCUMENTFILE:DESCRIPTION) "" ; # Short description of the original
34 set ::SAPDat(Document:DOCUMENTFILE:LANGUAGE) "" ; # Language Key
35 set ::SAPDat(Document:DOCUMENTFILE:CHECKEDIN) "" ; # Document is cheeked In
36 set ::SAPDat(Document:DOCUMENTFILE:ACTIVE_VERSION) "" ; # Active version of the original
37 set ::SAPDat(Document:DOCUMENTFILE:CREATED_AT) "" ; # Time of change (UTC)
38 set ::SAPDat(Document:DOCUMENTFILE:CHANGED_AT) "" ; # Time of change (UTC)
39 set ::SAPDat(Document:DOCUMENTFILE:CREATED_BY) "" ; # Name of person responsible
40 set ::SAPDat(Document:DOCUMENTFILE:CHANGED_BY) "" ; # Name of person responsible
41 set ::SAPDat(Document:DOCUMENTFILE:CONTENT_DESCRIPTION) "" ; # Description content version
Parameters
argsreserved for future usage
Returns
OK and global TCL array ::DIRResultDat with the feedback from the call or ERROR and list of hexed error message

DOCUMENTFILES->Checked Out Originals.

  • ::DIRResultDat(DOCUMENTFILES:DELETEVALUE:$Index) ; # Deletion Indicator
  • ::DIRResultDat(DOCUMENTFILES:DOCUMENTTYPE:$Index) ; # Document Type
  • ::DIRResultDat(DOCUMENTFILES:DOCUMENTNUMBER:$Index) ; # Document number
  • ::DIRResultDat(DOCUMENTFILES:DOCUMENTPART:$Index) ; # Document part
  • ::DIRResultDat(DOCUMENTFILES:DOCUMENTVERSION:$Index) ; # Document version
  • ::DIRResultDat(DOCUMENTFILES:ORIGINALTYPE:$Index) ; # Application number
  • ::DIRResultDat(DOCUMENTFILES:SOURCEDATACARRIER:$Index) ; # Name of Data Carrier
  • ::DIRResultDat(DOCUMENTFILES:STORAGECATEGORY:$Index) ; # Storage category for original files
  • ::DIRResultDat(DOCUMENTFILES:WSAPPLICATION:$Index) ; # Application
  • ::DIRResultDat(DOCUMENTFILES:DOCPATH:$Index) ; # Path for original file
  • ::DIRResultDat(DOCUMENTFILES:DOCFILE:$Index) ; # Original of document
  • ::DIRResultDat(DOCUMENTFILES:STATUSINTERN:$Index) ; # Document Status
  • ::DIRResultDat(DOCUMENTFILES:STATUSEXTERN:$Index) ; # Status of a document (language-dependent)
  • ::DIRResultDat(DOCUMENTFILES:STATUSLOG:$Index) ; # Document management log field
  • ::DIRResultDat(DOCUMENTFILES:APPLICATION_ID:$Index) ; # Logical document
  • ::DIRResultDat(DOCUMENTFILES:FILE_ID:$Index) ; # Physical document
  • ::DIRResultDat(DOCUMENTFILES:DESCRIPTION:$Index) ; # Short description of the original
  • ::DIRResultDat(DOCUMENTFILES:LANGUAGE:$Index) ; # Language Key
  • ::DIRResultDat(DOCUMENTFILES:CHECKEDIN:$Index) ; # Document is checked In
  • ::DIRResultDat(DOCUMENTFILES:ACTIVE_VERSION:$Index) ; # Active version of the original
  • ::DIRResultDat(DOCUMENTFILES:CREATED_AT:$Index) ; # Time of change (UTC)
  • ::DIRResultDat(DOCUMENTFILES:CHANGED_AT:$Index) ; # Time of change (UTC)
  • ::DIRResultDat(DOCUMENTFILES:CREATED_BY:$Index) ; # Name of person responsible
  • ::DIRResultDat(DOCUMENTFILES:CHANGED_BY:$Index) ; # Name of person responsible
  • ::DIRResultDat(DOCUMENTFILES:CONTENT_DESCRIPTION:$Index) ; # Description content version

Sample code sequence

1 set ::SAPDat(Document:DocumentKey:DOCUMENTNUMBER) [::TPSAP::DIR::getInternalDocumentNumber $SAPDocumentNumber]
2 set ::SAPDat(Document:DocumentKey:DOCUMENTTYPE) $SAPDocumentType
3 set ::SAPDat(Document:DocumentKey:DOCUMENTPART) $SAPDocumentPart
4 set ::SAPDat(Document:DocumentKey:DOCUMENTVERSION) $SAPDocumentVersion
5 set ::SAPDat(Document:Parameter:ORIGINALPATH) "$OriginalFilePath/"
6 set StatusList [::TPSAP::DIR::BAPI_DOCUMENT_CHECKOUTVIEW2]
7 if {[lindex StatusList 0] eq "OK"} {
8  # DOCUMENTFILES->Checked Out Originals.
9  foreach FileAttribute [::T4X::CORE::sortIndexedInterfaceTable [array names ::DIRResultDat DOCUMENTFILES:*]] {
10  puts "FileAttribute->$FileAttribute=$::DIRResultDat($FileAttribute)"
11  }
12 }

References TPSAP::getSessionLogChannel(), and tpco_scanHEX16().

◆ copyObjectLinks()

TPSAP::DIR::copyObjectLinks   SourceDocumentNumber SourceDocumentType SourceDocumentPart SourceDocumentVersion TargetDocumentNumber TargetDocumentType TargetDocumentPart TargetDocumentVersion ?TypesToIgnore? ?DeleteExistingLinks?  

Copies all object links from one document to another existing document.

Parameters
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
Returns
UPDATED or ERROR

References TPSAP::doCommitOrRollBackBasedOnStatus(), getDocumentInfoRecordInfo(), getInternalDocumentNumber(), TPSAP::getSessionLogChannel(), tpco_scanHEX16(), and tpwrite().

◆ ExistenceCheck()

TPSAP::DIR::ExistenceCheck   DocumentNumber DocumentType DocumentPart DocumentVersion args  

Checks, if a document info record exists in SAP.

Parameters
DocumentNumber
DocumentType
DocumentPart
DocumentVersion
argsnone
Returns
OK, NOT_FOUND or ERROR

References getInternalDocumentNumber(), and TPSAP::getSessionLogChannel().

◆ getActiveVersion()

TPSAP::DIR::getActiveVersion   DocumentNumber DocumentType DocumentPart args  

Retrieves the latest version of a SAP document info record object.

Parameters
DocumentNumber
DocumentType
DocumentPart
argsnone
Returns
Lastest version or ' ' (two blanks) if no version could be found

References getDocumentInfoRecordList(), getInternalDocumentNumber(), TPSAP::getSessionLogChannel(), and tpwrite().

Referenced by getLatestVersion().

◆ getActualVersion()

TPSAP::DIR::getActualVersion   DocumentNumber DocumentType DocumentPart DocumentVersion Date ?ReleaseOnly?  

This function determines the current and valid version of a document info record.

Parameters
DocumentNumber
DocumentType
DocumentPart
DocumentVersion
DateIn the internal format (YYYYMMDD)
ReleaseOnlyFlag to switch whether just the released versions or all the versions should be determined (Default ' ').
Returns
OK and version string as TCL list or ERROR

References getInternalDocumentNumber(), TPSAP::getSessionLogChannel(), and tpwrite().

◆ getDataCarrierInfo()

TPSAP::DIR::getDataCarrierInfo   DataCarrierName HostName ?SapSystem? ?SapClient? args  

Retrieves detailed information about a SAP data carrier.

Parameters
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
argsnone
Returns
OK and global TCL array ::DIRResultDat or ERROR

References TPSAP::getSessionLogChannel(), and TPSAP::RfcGetAttributes().

◆ getDocumentInfoRecordInfo()

TPSAP::DIR::getDocumentInfoRecordInfo   DocumentNumber DocumentType DocumentPart DocumentVersion ?GetActiveFileFlag? ?GetComponentsFlag? ?GetLongTextsFlag? ?GetObjectLinksFlag? ?GetStatusLogFlag? ?GetStructureFlag? ?GetClassificationFlag?  

Retrieves SAP document info record information.

Parameters
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
Returns
OK and global TCL array ::DIRResultDat or ERROR

References getInternalDocumentNumber(), TPSAP::getSessionLogChannel(), tpco_scanHEX16(), and tpwrite().

Referenced by copyObjectLinks(), and T4S::PROP::CUSTOM::MAPPING::GetDIRData().

◆ getDocumentInfoRecordList()

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.

Parameters
args
Returns
OK and global TCL array ::DIRResultDat

References TPSAP::getSessionLogChannel().

Referenced by getActiveVersion().

◆ getDocumentState()

TPSAP::DIR::getDocumentState   DocumentNumber DocumentType DocumentPart DocumentVersion args  

Retrieves the document state for a given SAP document info record object.

Parameters
DocumentNumber
DocumentType
DocumentPart
DocumentVersion
argsnone
Returns
OK and global TCL array ::DIRResultDat (within section STATUSINTERN or STATUSEXTERN) or ERROR

References getInternalDocumentNumber(), and TPSAP::getSessionLogChannel().

◆ getDocumentTypeInfo()

TPSAP::DIR::getDocumentTypeInfo   DocumentType ?SapSystem? ?SapClient? args  

Retrieves detailed information about a SAP document info record type.

Parameters
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
argsnone
Returns
OK and global TCL array ::DIRResultDat or ERROR

References TPSAP::getSessionLogChannel(), and TPSAP::RfcGetAttributes().

◆ getExternalDocumentNumber()

TPSAP::DIR::getExternalDocumentNumber   InternalNumber  

Retrieves the SAP external document id for a given SAP internal document id.

Parameters
InternalNumberSAP internal document id
Returns
External number

References T4X::CORE::getSessionLogChannel(), TPSAP::getSessionLogChannel(), tpco_scanHEX16(), and tpwrite().

Referenced by T4S::DIR::CUSTOM::MAPPING::SAP_DocumentInfoRecord2TC_Object(), and TPSAP::ECM::updateObjectManagementRecord().

◆ getInternalDocumentNumber()

TPSAP::DIR::getInternalDocumentNumber   ExternalNumber  

◆ getLatestVersion()

TPSAP::DIR::getLatestVersion   DocumentNumber DocumentType DocumentPart args  

Retrieves the latest version of a SAP document info record object.

Parameters
DocumentNumber
DocumentType
DocumentPart
argsnone
Returns
Lastest version or ' ' (two blanks) if no version could be found

References getActiveVersion(), and TPSAP::getSessionLogChannel().

◆ getStatusList()

TPSAP::DIR::getStatusList   DOCUMENTTYPE ?GETSTATUSNETWORK? ?STATUSEXTERN? ?STATUSINTERN?  

Retrieves the document state net for a given SAP document type.

Parameters
DOCUMENTTYPE
GETSTATUSNETWORK
STATUSEXTERN
STATUSINTERN
Returns
OK and global TCL array ::DIRResultDat (within section STATUSINTERN or STATUSEXTERN) or ERROR

References TPSAP::getSessionLogChannel().

◆ initSAPDocumentDescription()

TPSAP::DIR::initSAPDocumentDescription   Index args  

Resets part the corresponding global TCL ::SAPDat array within the section Document.

Parameters
Index-> TCL array index
argsnone
Returns
OK

References TPSAP::getSessionLogChannel().

Referenced by setSAPDocumentDescription().

◆ initSAPDocumentOriginalStructure()

TPSAP::DIR::initSAPDocumentOriginalStructure   FileIndex args  

Resets part the corresponding global TCL ::SAPDat array within the section Document.

Parameters
FileIndex-> TCL array index
argsnone
Returns
OK

References TPSAP::getSessionLogChannel().

◆ initSAPDocumentStructure()

TPSAP::DIR::initSAPDocumentStructure   args  

Resets part the corresponding global TCL ::SAPDat array within the section Document.

Parameters
argsnone
Returns
OK

References TPSAP::getSessionLogChannel().

Referenced by T4S::PROP::CUSTOM::MAPPING::GetDIRData().

◆ initSAPDocumentStructureStructure()

TPSAP::DIR::initSAPDocumentStructureStructure   Index args  

Resets part the corresponding global TCL ::SAPDat array within the section Document.

Parameters
Index-> TCL array index
argsnone
Returns

References TPSAP::getSessionLogChannel().

Referenced by setSAPDocumentStructureStructure().

◆ setDocumentState()

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.

Parameters
DocumentNumber
DocumentType
DocumentPart
DocumentVersion
ChangeNumberChangenumber that define the valid from date of the status change
NewStateNew document status
StateReasonReason that will be used in the status log of SAP Document
argsnone
Returns
OK for a successul update of the status and ERROR in all other cases

References TPSAP::doCommitOrRollBackBasedOnStatus(), getInternalDocumentNumber(), and TPSAP::getSessionLogChannel().

◆ setSAPDocumentDescription()

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.

Parameters
Index-> TCL array index
Language
LanguageIso
Description
DeleteValue(optional - empty)
TextIndicator(optional - empty)
argsnone
Returns
OK

References TPSAP::getSessionLogChannel(), and initSAPDocumentDescription().

Referenced by T4S::DIR::CUSTOM::MAPPING::TC_Object2SAP_DocumentInfoRecord().

◆ setSAPDocumentStructureStructure()

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.

Parameters
Index-> TCL array index
DocumentType
DocumentNumber
DocumentPart
DocumentVersion
SortString(optional - empty)
Quantity(optional - 1)
DeleteValue(optional - empty)
argsnone
Returns
OK

References getInternalDocumentNumber(), TPSAP::getSessionLogChannel(), and initSAPDocumentStructureStructure().