SAP Function SDOK_PHIOS_CHECKIN - Check In Physical Documents to Knowledge Provider

Parameter Reference Type Length Default Optional Text
CLIENT SYST-MANDT C 3 SY-MANDT X
FTP_KEEP_OPEN_FLAG SYST-DATAR C 1 X Flag for Keeping FTP Connection Open

Parameter Reference Length Optional Text
BAD_OBJECTS SDOKERRKEY 44 Objects That Cannot Be Imported
COMPONENTS SDOKCOMCHI 697 X Component Information
OBJECT_FILEPROPERTIES SDOKIMPORT 578 X Obsolete, Only Use "COMPONENTS"

Functionality
This function module is used to check in physical documents.
When being checked in, physical documents with the status "initial" canhave their status changed to "protected" or "no content".
When a document gets the status "protected", files are copied from thefile system of the front-end computer to the Content Server, thuscreating physical documents with content. The status indicator "checkedout" is then removed from the documents that the current user hadchecked out.
When the document status is set to "protected", one entry is written tothe table COMPONENTS for each component of the physical document. (Thetable OBJECT_FILEINFORMATIONS is obsolete and should no longer beused.) Each table entry contains the following information about thecomponent:

  • Document class

  • Document ID

  • Source directory on the front-end computer

  • File name

  • File size

  • MIME type

  • File type flag:

    • ,,T : text file
    ,,B : binary file
    ,,initial value : if no file type could be specified
    Document class, document ID, source directory, and file name aremandatory data. If no MIME type is specified, components that areflagged as text are set to MIME type "text/plain". Otherwise, the MIMEtype is left blank. If no file type is specified, and if the MIME typeis "text/...", the file type is set to text. Otherwise, the file typeis set to binary.
    When a physical document is checked in without content, that is, whenthe status indicator is set to "no content", all that is required inthe table COMPONENTS is one entry per document, specifying the classand the document ID.
    After the function module is called, an entry is created in the tableCOMPONENTS for every document whose status was changed. The data foreach entry is obtained from the call.
    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 asfollows:
    ,,0:,,bad class:,,,,,,,,no class could be determined for phyiscaldocument(s)
    ,,1:,,not_existing:,,,,,,document does not exist
    ,,2:,,not_allowed:,,,,,,operation cannot be executed
    ,,,,,,Possible causes: another user has already checked out or reservedthis document, or the document does not have status "initial"
    ,,3: missing_directory:,,,,source directory not specified
    ,,5: transfer_error:,,,,,,error with data transfer
    ,,6: not_authorized:,,,,,,you have no authorization for this function
    ,,7:,,connection_error:,,,,a connection to the database could not beset up
    ,,8:,,bad_storage_category:,,the storage category entered for thisphysical document is unknown
    ,,17:,,missing_filename:,,,,the file name was not specified

    Notes
    It is not currently possible to check in files from the file system ofthe application server, or from just any content client.
    If the function module is likely to be called several times insuccession, 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.