Ansicht
Dokumentation

SDOK_PHIOS_CHECKOUT - Check Out Physical Documents from Knowledge Provider

BAL Application Log Documentation   Addresses (Business Address Services)  
This documentation is copyright by SAP AG.

Functionality

This function module checks out specified physical documents.

When a document is checked out, its content is copied to the file system of the front-end computer, and a lock is placed on the master version on the server, so that no other users can access the document.

When this function module is called, an entry is made for each document checked out in the table OBJECT_FILE_INFORMATIONS. The entry contains the document class, the document ID, and the directory on the front-end computer where the local copy of the document is stored. After the function module is called, the file names of the documents are listed as export parameters in the table. Since one document may consist of a number of files, there may be multiple entries per document in the table. If a number of table entries have the same document IDs, this indicates that this document consists of multiple files.

During the checkin process, each document is either completely checked in, or not checked in at all. If individual documents cannot be checked in, the names of these documents and the appropriate error code are entered 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 set up

,,8:,,bad_storage_category:,,the storage category entered for this physical document is unknown

Example

Notes

• 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 the FTP_KEEP_OPEN_FLAG flag to ensure that the same FTP connection is used for all transfers.

• If the application cannot differentiate between file names, it creates separate directories for each document. This avoid name conflicts. This may the case with HTML documents and referenced GIF files, for example.

Further information

Parameters

BAD_OBJECTS
CLIENT
COMPONENTS
FTP_KEEP_OPEN_FLAG
OBJECT_FILE_INFORMATIONS
SUPPRESS_TRANSFER

Exceptions

Function Group

SDCL

General Material Data   CPI1466 during Backup  
This documentation is copyright by SAP AG.

Length: 3097 Date: 20240523 Time: 065951     sap01-206 ( 67 ms )