FILE_METADATA

Definition


The FILE_METADATA table contains information about the different data files generated by SAP Convergent Charging

Description


During the execution of the different processes handled by SAP Convergent Charging, data files are generated for multiple purposes such as integration with third-party systems, error management, notifications, and so on.

The metadata contained in this table is used by the "Analyze Item Files" web application for monitoring purpose.

Technical Data


Schema Version 2025.0.1
Filegroup MONITORING_DATA
Partitioned No

Summary


The FILE_METADATA table is defined by the following columns in your back-end database. See the column details for more information.

Name PK FK IX Uses Used by Definition
CLIENT_NUMBER        

    The client number associated to the data file
    NAME PK_FILE_METADATA       

      The name of the data file (without any extension)
      ROOT_NAME        

        The name of the root data file (without any extension)

        More...

        PARENT_NAME        

          The name of the parent data file (without any extension)

          More...

          FORMAT        

            The format of the data file

            More...

            STATUS        

              The current status of the data file

              More...

              ITEM_TYPE        

                The type of items contained in the data file

                More...

                PRODUCER        

                  The identifier of the instance which produced the data file, or "unknown" if the producer cannot be determined
                  CONSUMER        

                    The identifier of the instance which consumed the data file
                    CLASS_NAME        

                      The name of the item class related to the items contained in the data file
                      WRITTEN_ITEMS_RATER        

                        The number of items written by the rater instance in the data file
                        WRITTEN_ITEMS_BULKLOADER        

                          The number of items written by the bulkloader instance in the data file
                          UNPROCESSED_ITEMS        

                            The number of items which have not been processed yet
                            SUCCESSFUL_ITEMS        

                              The number of items which were successfully processed
                              LOST_ITEMS        

                                The number of items which could not be processed

                                More...

                                ERRONEOUS_ITEMS        

                                  The number of items which could not be sent to SAP CI while processing the data file and were written to error data files
                                  PENDING_ERRONEOUS_ITEMS        

                                    The number of items which still need to be sent to SAP CI by processing the related error data files

                                    More...

                                    CREATION_EVENT        

                                      The event which triggered the creation of the data file

                                      More...

                                      CREATION_DATE     IX_FILE_METADATA_CREATION   

                                        The date and time when the data file was created
                                        WRITING_END_DATE        

                                          The date and time when the writing of the data file ended
                                          PROCESSING_START_DATE        

                                            The date and time when the processing of the data file started
                                            PROCESSING_END_DATE        

                                              The date and time when the processing of the data file ended
                                              PRODUCER_PATH_OID       FILE_METADATA_PATH (OID)
                                               

                                                The unique identifier of the file system path where the data file was located when it was produced

                                                More...

                                                CONSUMER_PATH_OID       FILE_METADATA_PATH (OID)
                                                 

                                                  The unique identifier of the file system path where the data file was located when it was consumed

                                                  More...

                                                  JCO_DESTINATION        

                                                    The JCo destination associated to the items contained in the data file

                                                    More...

                                                    CHECKSUM        

                                                      The checksum of the data file (computed using the 'SHA-256' algorithm)
                                                      CHECKSUM_STATUS        

                                                        The status of the computation and verification of the checksum of the data file

                                                        More...

                                                        PURGE_REFERENCE_DATE     IX_FILE_METADATA_PURGE   

                                                          The purge reference date of the file metadata

                                                          More...

                                                          REPROCESSED        

                                                            Specifies whether the file was reprocessed or not

                                                            More...

                                                            Column Details

                                                            The database schema defines the following columns. Check the definitions, types, available indexes, and formats:

                                                            CLIENT_NUMBER

                                                            Definition The client number associated to the data file
                                                            Type DECIMAL(3), NOT NULL

                                                            NAME

                                                            Definition The name of the data file (without any extension)
                                                            Type NVARCHAR(300), NOT NULL
                                                            Primary Key PK_FILE_METADATA

                                                            ROOT_NAME

                                                            Definition The name of the root data file (without any extension)
                                                            Description

                                                            • For data files generated during the charging process, the root name of the data file equals to its name
                                                            • For data files related to erroneous items, the root name corresponds to the name of the data file initially containing the items

                                                            The value of this field corresponds to an entry in the FILE_METADATA table.

                                                            Type NVARCHAR(300), NULL

                                                            PARENT_NAME

                                                            Definition The name of the parent data file (without any extension)
                                                            Description

                                                            • For data files generated during the charging process, the parent name is empty
                                                            • For data files related to erroneous items, the parent name corresponds to the name of the processed data file

                                                            The value of this field corresponds to an another entry in the FILE_METADATA table.

                                                            Type NVARCHAR(300), NULL

                                                            FORMAT

                                                            Definition The format of the data file
                                                            Format

                                                            The possible values are:

                                                            • 0: uncompressed CSV file
                                                            • 1: CSV file compressed using the GZIP format
                                                            • 2: CSV file compressed using the ZIP format

                                                            Type DECIMAL(2), NOT NULL

                                                            STATUS

                                                            Definition The current status of the data file
                                                            Format

                                                            The possible values are:

                                                            • 0: the file was created
                                                            • 1: the file is being written
                                                            • 2: the file was archived and is ready for being processed by a bulkloader
                                                            • 3: the file is being cleaned
                                                            • 4: the file is being read and processed by a bulkloader
                                                            • 5: the file was entirely processed by a bulkloader and renamed
                                                            • 6: the file was entirely processed by a bulkloader and deleted
                                                            • 7: the file could not be entirely read by a bulkloader

                                                            Type DECIMAL(2), NOT NULL

                                                            ITEM_TYPE

                                                            Definition The type of items contained in the data file
                                                            Format

                                                            The possible values are:

                                                            • 0: postpaid charged items
                                                            • 1: prepaid charged items
                                                            • 2: refill records
                                                            • 3: charged chargeable items
                                                            • 4: acquired chargeable items
                                                            • 5: notifications
                                                            • 6: rerating notifications
                                                            • 7: unknown

                                                            Type DECIMAL(2), NOT NULL

                                                            PRODUCER

                                                            Definition The identifier of the instance which produced the data file, or "unknown" if the producer cannot be determined
                                                            Type NVARCHAR(16), NOT NULL

                                                            CONSUMER

                                                            Definition The identifier of the instance which consumed the data file
                                                            Type NVARCHAR(16), NULL

                                                            CLASS_NAME

                                                            Definition The name of the item class related to the items contained in the data file
                                                            Type NVARCHAR(256), NOT NULL

                                                            WRITTEN_ITEMS_RATER

                                                            Definition The number of items written by the rater instance in the data file
                                                            Type DECIMAL(28), NOT NULL

                                                            WRITTEN_ITEMS_BULKLOADER

                                                            Definition The number of items written by the bulkloader instance in the data file
                                                            Type DECIMAL(28), NOT NULL

                                                            UNPROCESSED_ITEMS

                                                            Definition The number of items which have not been processed yet
                                                            Type DECIMAL(28), NOT NULL

                                                            SUCCESSFUL_ITEMS

                                                            Definition The number of items which were successfully processed
                                                            Type DECIMAL(28), NOT NULL

                                                            LOST_ITEMS

                                                            Definition The number of items which could not be processed
                                                            Description

                                                            The possible reasons are:

                                                            • The items could not be read during cleaning
                                                            • The items were written by the rater but not found by the bulkloader
                                                            • The items statuses could not be determined after a bulkloader restart when resuming the processing of the data file

                                                            Type DECIMAL(28), NOT NULL

                                                            ERRONEOUS_ITEMS

                                                            Definition The number of items which could not be sent to SAP CI while processing the data file and were written to error data files
                                                            Type DECIMAL(28), NOT NULL

                                                            PENDING_ERRONEOUS_ITEMS

                                                            Definition The number of items which still need to be sent to SAP CI by processing the related error data files
                                                            Description

                                                            This field is only set for data files generated during the charging process.

                                                            Type DECIMAL(28), NOT NULL

                                                            CREATION_EVENT

                                                            Definition The event which triggered the creation of the data file
                                                            Format

                                                            The possible values are:

                                                            • 0: the data file was created to store items generated during the charging process
                                                            • 1: the data file was created to store items which could not be sent to SAP CI because they were invalid
                                                            • 2: the data file was created to store items which could not be sent to SAP CI because of a communication error
                                                            • 3: the creation event of the data file is unknown

                                                            Type DECIMAL(2), NOT NULL

                                                            CREATION_DATE

                                                            Definition The date and time when the data file was created
                                                            Type DATETIME, NOT NULL
                                                            Available Index IX_FILE_METADATA_CREATION

                                                            WRITING_END_DATE

                                                            Definition The date and time when the writing of the data file ended
                                                            Type DATETIME, NULL

                                                            PROCESSING_START_DATE

                                                            Definition The date and time when the processing of the data file started
                                                            Type DATETIME, NULL

                                                            PROCESSING_END_DATE

                                                            Definition The date and time when the processing of the data file ended
                                                            Type DATETIME, NULL

                                                            PRODUCER_PATH_OID

                                                            Definition The unique identifier of the file system path where the data file was located when it was produced
                                                            Description

                                                            The unique identifier is generated by the system and corresponds to an entry in the FILE_METADATA_PATH table.

                                                            Type DECIMAL(8), NOT NULL

                                                            CONSUMER_PATH_OID

                                                            Definition The unique identifier of the file system path where the data file was located when it was consumed
                                                            Description

                                                            The unique identifier is generated by the system and corresponds to an entry in the FILE_METADATA_PATH table.

                                                            Type DECIMAL(8), NOT NULL

                                                            JCO_DESTINATION

                                                            Definition The JCo destination associated to the items contained in the data file
                                                            Description

                                                            This JCo destination corresponds to a configuration entry defined in the CONFIGURATION table.

                                                            Type NVARCHAR(16), NULL

                                                            CHECKSUM

                                                            Definition The checksum of the data file (computed using the 'SHA-256' algorithm)
                                                            Type NVARCHAR(64), NULL

                                                            CHECKSUM_STATUS

                                                            Definition The status of the computation and verification of the checksum of the data file
                                                            Format

                                                            The possible values are:

                                                            • 0: no checksum was computed for the data file
                                                            • 1: the checksum of the data file was computed after writing but was not verified
                                                            • 2: the checksum computed after writing the data file matches the one computed after reading it
                                                            • 3: the checksum computed after writing the data file does not match the one computed after reading it

                                                            Type DECIMAL(2), NOT NULL

                                                            PURGE_REFERENCE_DATE

                                                            Definition The purge reference date of the file metadata
                                                            Description

                                                            This date corresponds to the writing end date of the root data file. This information remains empty until the root data file is archived.

                                                            Type DATETIME, NULL
                                                            Available Index IX_FILE_METADATA_PURGE

                                                            REPROCESSED

                                                            Definition Specifies whether the file was reprocessed or not
                                                            Format

                                                            The possible values are:

                                                            • 0: the file was not reprocessed
                                                            • 1: the file was reprocessed

                                                            Type DECIMAL(1), NOT NULL

                                                            Primary Key Details

                                                            See the primary key information:

                                                            PK_FILE_METADATA

                                                            Column(s) NAME
                                                            Filegroup MONITORING_DATA

                                                            Index Details

                                                            The following database indexes are available in the FILE_METADATA database table to improve the speed of data retrieval operations during the business processes of SAP Convergent Charging:

                                                            IX_FILE_METADATA_CREATION

                                                            Indexed Column(s) CREATION_DATE
                                                            Unique No
                                                            Partitioned No
                                                            Clustered No
                                                            Filegroup MONITORING_INDX

                                                            IX_FILE_METADATA_PURGE

                                                            Indexed Column(s) PURGE_REFERENCE_DATE
                                                            Unique No
                                                            Partitioned No
                                                            Clustered No
                                                            Filegroup MONITORING_INDX