Fonction SAP BAPI_SRM_DOC_CHECKOUT_CONT_TAB - SRM BAPI: Get Document Content by Specifying Tables

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
DOCUMENTCLASS BAPISRMDOC-DOCCLASS C 10 '' Location of Document
DOC_CONTEXT BAPIDOCCONTEXT u 64 X Access Context: RMS ID and SPS ID
DO_COMMIT BAPISRMDOC-BOOLEAN C 1 X 'X': Do Commit
OBJECTID BAPISRMDOC-GUID C 32 Internal Document ID
VARIANT BAPISRMDOC-VARIANT I 4 0 X Variant Number
VERSION BAPISRMDOC-VERSION I 4 0 X Physical Version Number
X_SET_CHECKED_OUT BAPISRMDOC-BOOLEAN C 1 X 'X': Set Check-Out Lock

Paramètre Reférence Type Long. Description
RETURN BAPIRET2 u 548 Return Parameter

Paramètre Reférence Long. Facultatif Description
ASCII_CONTENT BAPIASCONT255 255 X ASCII Content
BIN_CONTENT BAPICONTENT255 255 X Binary Content
COMPONENTS BAPIDOCCOMP 400 Document Components

Functionality
The function module BAPI_SRM_DOC_CHECKOUT_CONT_TAB is used toget the document content from the Records Management back end for theclient application. The document content is sent in the internal tableBIN_CONTENT or ASCII_CONTENT, with row lengths of 255. This means thatthe function module can also be used in the BOR object.
Use the field binary_flag in the structure BAPIDOCCOMP to identifywhether the content of a component can be retrieved from the ASCIItable ASCII_CONTENT (binary_flag <> 'X') or from the binary tableBIN_CONTENT (binary_flag = 'X'). You can use the component size androw length from BIN_CONTENT or ASCII_CONTENT (calculated in bytes)to calculate the offset where a component starts and ends in theinternal table. A new component always starts with a new row.

Example
CALL FUNCTION 'BAPI_SRM_DOC_CHECKOUT_VIA_TAB'
EXPORTING
objectid = objectid
documentclass = documentclass
* version = version " version = 0 variant = 0 stands for thecurrent version
* variant = variant
IMPORTING
return = return
TABLES
components = components
ascii_content = ascii_content
bin_content = bin_content
.

Description
Result of the BAPI call

Description
Location of document

Value range
Location of document (content model)

Description
Context for accessing documents. If the document is stored on a WebDAVserver, you must specify the RMS ID and SPS ID in the document context.

Description
'X': Perform commit

Description
Internal ID of document

Value range
Internal ID of document

Description
Variant number

Value range
Variant number; 0 is the current variant

Description
Physical version number

Value range
Physical version number; 0 is the current version

Description
'X': Set check-out lock

Description
Table for document components in ASCII format

Description
Table for content in binary format

Description
Table for the description of the document component.
comp_count: Specifies the order of the components in the transferredcontent table. The field is not stored persistently in the backendrepository.
comp_id: Name of the component
mimetype: MIME type
comp_size: File size of the component in bytes
binary_flag: 'X'- Component is in binary format; ' '- ASCII format
comp_num: Numbering of the components in the document, is storedpersistently in the backend repository.