Fonction SAP ARCHIVE_ADMIN_GET_FILE_INFO - Determine Information on Archive File

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
ARCHIVE_NAME ADMI_FILES-ARCHIV_KEY C 20 Identification of an Archive File
ARCHIVE_SYSTEM_ONLY C C 0 SPACE X ADK Internal: Check for File in Storage System Only
CONTENT_REPOSITORY ARCH_USR-CREP C 30 SPACE X ADK Internal: Content Repository Containing the File
DOCUMENT_ID ADMI_FILES-ARCH_DOCID C 40 SPACE X ADK Internal: Document ID for the File in the Archive System
EXCEPTION_ON_ACCESS_ERROR C C 0 'X' X ADK Internal: Raise an Exception When Access Error
FILESYSTEM_ONLY C C 0 SPACE X ADK Internal: Check for File in File System Only
LOGICAL_PATHNAME ADMI_FILES-PATHINTERN C 60 SPACE X ADK Internal: Logical Path for File
PHYSICAL_FILENAME ADMI_FILES-FILENAME C 255 SPACE X ADK Internal: Physical Name of the File (Without Path)
URI ADMI_URI_ADK C 255 X URI of a Resource or a Collection
WEBDAV_DEST ADMI_WEBDAV_DESTINATION C 32 X HTTP Connection to XML DAS for WebDAV
WEBDAV_SYSTEM_ONLY C C 0 SPACE X ADK Internal: Only Check File in WebDAV System

Paramètre Reférence Type Long. Description
ARCHIVE_CODE_PAGE TCP00-CPCODEPAGE N 4 Code Page of the Archive File
ARCHIVE_CREATION_CLIENT HEADA-CLIENT C 3 Client in Which the Archive File Was Created
ARCHIVE_CREATION_DATE HEADA-DATUM D 8 Creation Date for Archive File
ARCHIVE_CREATION_RELEASE HEADA-SAPRL C 4 Release Status of SAP System at time of Archiving
ARCHIVE_CREATION_SYSTEM HEADA-SYSID C 8 Name of SAP System at Time of Archiving
ARCHIVE_KEY ADMI_FILES-ARCHIV_KEY C 20 Identification of the Archive File According to File
ARCHIVE_NUMBER_FORMAT TCP00-CPCODEPAGE N 4 Number Format of the Archive File
ARCHIVE_SYSTEM C C 0 Accessibility of Archive File in Storage System
FILESYSTEM C C 0 Accessibility of the Archive File in the File System
INVALID BOOLE_D C 1 Indicates Whether the Archive File Is Invalid: TRUE (='X') and FALSE (=' ')
OBJECT HEADA-OBJECT C 10 Archiving Object According to File
PHYSICAL_FILE_WITH_PATH ADMI_FILES-FILENAME C 255 File Name of Archive File
STORED_AS_DOCUMENT_ID ADMI_FILES-ARCH_DOCID C 40 ADK Internal: Document ID for File in Storage System
STORED_AS_URI ADMI_URI_ADK C 255 ADK Internal: URI of the File in the WebDAV System
STORED_IN_CONTENT_REPOSITORY ADMI_FILES-CREP C 30 ADK Internal: Content Repository Containing the File
STORED_IN_WEBDAV_DEST ADMI_WEBDAV_DESTINATION C 32 ADK Internal: WebDAV Connection Used to Store the File
VALUES_CONSISTENT C C 0 Compatibility of Management Data in File and SAP System
WEBDAV_SYSTEM C C 0 Availability of the Archive File in the WebDAV System

Exception Description
FILE_IO_ERROR Error Reading File
FILE_NOT_FOUND Data Access Not Possible Due to Lack of Management Information
NO_ARCHIVE_FILE The File is not an Archive File
OPEN_ERROR Error when opening file

Functionality
The function module ARCHIVE_ADMIN_GET_FILE_INFO checks thephysical accessibility of an archive file that is identified using theimport parameter ARCHIVE_NAME. The check is carried out byimporting the file header. If an error occurs, an exception is created.
The following information - contained in the file header - is alsoreturned:

  • Archiving object

  • ADK key for the identification of the file

  • Name of the SAP System in which the file was created

  • Client in which the file was created

  • Release status of the SAP System in which the file was created

  • Creation date of the file

  • Code page and number format of the file

    • If the values for these parameters are not the same as those in themanagement data for this file in the SAP System, the value of thereturn parameter VALUES_CONSISTENT blank.

    Notes
    Physical access is insufficient for a file to be read by the ArchiveDevelopment Kit (ADK). The management data in the file and the SAPSystem must be the same.

    Description
    Code page for the archive file

    Description
    The client in which the archive file was created.

    Description
    The date recorded in the file on which the archive file was created.

    Description
    The release status of the SAP System in which the archive file wascreated.

    Description
    The name of the SAP System (system ID) in which the archive file wascreated.

    Description
    The ADK key that is recorded for this archive file.

    Description
    Number format for the archive file

    Description
    If this paramter is not initial when it is returned, it is possible toaccess the file in the storage system.
    A file's place of storage and the value in parameter ARCHIVE_SYSTEMare not relevant for the use of the Archive Development Kit (ADK).

    Description
    If this parameter is not blank when returned, the file can be accessedin the file system.
    An archive file's storage destination and the value of the parameterFILESYSTEM are not relevant for the application of the ArchiveDevelopment Kit (ADK).

    Description
    The archiving object recorded in the file.

    Description
    Physical file name including file path (regardless of whether the fileis accessible).

    • For archive files that were created from Release 4.0: Name and path
      • correspond with the current platform (syntax group for the operatingsystem).
      • For archive files from earlier releases: Originally created name and
        • path according to archive management.

        Default
        , in case

        • an error occurred when determining the physical from the logical file
          • name or
          • no file name is recorded in archive management (for example because the
            • file was stored) and also the import parameter LOGICAL_PATHNAME andPHYSICAL_FILENAME were not provided.

            Description
            ID under which the archive file is stored in the Content Repository.
            For an ADK application, the storage location of an archive file isirrelevant. Querying this parameter outside ADK therefore does not makesense.

            Description
            Content Repository where the archive file is located.
            For an ADK application, the storage location of an archive file isirrelevant. Querying this parameter outside ADK therefore does not makesense.

            Description
            Indicator that shows whether the management data stored in the file isthe same as the data on the file that was stored in the SAP System. Ifthis parameter is returned blank, the values in the file and the SAPSystem do not agree for at least one of the following sizes:

            • Archiving object

            • System ID

            • Client in which the file was created (if the archiving object is not
              • marked as cross-client)
              • ADK key for the archive file

                • Description
                ADK key for an archive file. When calling a function module, specifyingthis parameter is usually sufficient. Further data, such as thephysical file name and storage location, are then determinedautomatically, and the file check is carried out.

                Description
                If, when you call the function module, this parameter is not blank, thearchive file check is omitted. The file can only be accessed in thestorage system.
                Since the storage location of an archive file is not relevant for theapplication of the Archive Development Kit (ADK), it is not necessaryto make an entry in this parameter outside the ADK.

                Description
                Specifies the Content Repository to be searched for the specifiedarchive file.
                If, when this function module is called, this parameter and theparameter DOCUMENT_ID are specified, their values form the basisfor access to the file instead of the corresponding entries in the ADKadministration data.
                When calling the function module outside the Archive Development Kit(ADK). the storage location of an archive file is automaticallydetermined, and is also not relevant for the application of ADK. Thereis therefore no point in making an entry for this parameter outside ofthe ADK.

                Description
                Specifies the document ID under which the storage system stored thefile.
                If, when the function module is called, this parameter and theparameter CONTENT_REPOSITORY are specified, their values areused as a basis for accessing the data instead of the correspondingentries in the ADK management data.
                When calling the function module outside the Archive Development Kit(ADK), the storage location of an archive file is automaticallydetermined and is therefore not relevant for the application of theADK. There is therefore no point in making an entry in this parameteroutside the ADK.

                Description
                If this parameter is initial when it is transferred, the functionmodule does not raise an exception in the case of a read error.Instead, the parameters FILESYSTEM and ARCHIVE_SYSTEM arereturned initial.
                Since the place of storage is not relevant for the use of the ArchiveDevelopment Kit (ADK), it is not necessary to make an entry in thisparameter outside the ADK.

                Description
                If, when the function module is called, this parameter is blank, thearchive file check is skipped in the storage system. The file is onlyaccessed in the file system.
                Since an archive file's storage location is not relevant forapplication of the Archive Devleopment Kit (ADK), there is no point inmaking an entry for this parameter outside the ADK.

                Description
                Specifies the logical path that indicates the directory in which thefile in the file system is stored.
                If, when the function module is called, this parameter and theparameter PHYSICAL_FILENAME are specified, their values are usedas a basis for accessing the data instead of the corresponding data inADK management data.
                When calling this function module outside the Archive Development Kit(ADK), the storage location of an archive file is automaticallydetermined. It is not relevant for the application of the ADK. There isno point in making an entry for this parameter outside the ADK.

                Description
                Specifies the physical file name under which the file is stored in thefile system.
                If, when the function module is called, entries are made in this andthe parameter LOGICAL_FILENAME, these values are taken as abasis for access to the file instead of the corresponding entries inthe ADK management data.
                When calling the function module outside the Archive Development Kit(ADK), the storage location of an archive file is automaticallydetermined. It is not relevant for the application of the ADK. There istherefore no point in making entries for these parameters outside theADK.