SAP Function SDOK_PHIOS_CHECKOUT - Check Out Physical Documents from Knowledge Provider

Parameter Reference Type Length Default Optional Text
CLIENT SYST-MANDT C 3 SY-MANDT X Client
FTP_KEEP_OPEN_FLAG SYST-DATAR C 1 X Obsolete, Do Not Use
SUPPRESS_TRANSFER SYST-DATAR C 1 X 'X' --> No Content Transfer

Parameter Reference Length Optional Text
BAD_OBJECTS SDOKERRKEY 44 Objects That Could Not Be Checked Out
COMPONENTS SDOKCOMCHO 952 X Component Information
OBJECT_FILE_INFORMATIONS SDOKEXPORT 552 X Obsolete, Only Use "COMPONENTS"

Functionality
This function module checks out specified physical documents.
When a document is checked out, its content is copied to the filesystem of the front-end computer, and a lock is placed on the masterversion on the server, so that no other users can access the document.
When this function module is called, an entry is made for each documentchecked out in the table OBJECT_FILE_INFORMATIONS. The entry containsthe document class, the document ID, and the directory on the front-endcomputer where the local copy of the document is stored. After thefunction module is called, the file names of the documents are listedas export parameters in the table. Since one document may consist of anumber of files, there may be multiple entries per document in the t
able. If a number of table entries have the same document IDs, thisindicates that this document consists of multiple files.
During the checkin process, each document is either completely checkedin, or not checked in at all. If individual documents cannot be checkedin, the names of these documents and the appropriate error code areentered in the table BAD_OBJECTS. The most common error codes are:
,,0:,,bad class:,,,,no class could be determined for document(s)
,,1:,,not_existing:,,,,document does not exist
,,2:,,not_allowed:,,,,operation cannot be executed
,,,,,,,,,,,,,,Possible causes:
,,,,,,,,,,,,,,-,,document is already checked out
,,,,,,,,,,,,,,-,,another user has reserved this document
,,,,,,,,,,,,,,-,,document has the status "protected"
,,3:,,missing_directory:,,target directory not specified
,,5:,,transfer_error:,,,,error during data transfer
,,6:,,not_authorized:,,,,you have no authorization for this function
,,7:,,connection_error:,, a connection to the database could not be setup
,,8:,,bad_storage_category:,,the storage category entered for thisphysical document is unknown

  • It is not currently possible to check in files from the file system of
    • the application server, or from just any content client.
    • If the function module is likely to be called several times in
      • succession, and if data is transferred via FTP, you can set theFTP_KEEP_OPEN_FLAG flag to ensure that the same FTP connection is usedfor all transfers.
      • If the application cannot differentiate between file names, it creates
        • separate directories for each document. This avoid name conflicts. Thismay the case with HTML documents and referenced GIF files, for example.