Child pages
  • FileID format
Skip to end of metadata
Go to start of metadata
Specification and consideration for the FileID keys used to identify files in the bit repository.


The key is constructed by using the file name including the path in the batch structure with the batchid (including round trip number) as the root element. The path separator is the '_' (underscore) char. The maximum length allowed is 250.

The fileID must conform to the regular expression: [a-zA-Z0-9\-_.] {5,250}

Example: The file


in batch structure will be archived with fileID:



The defined format is based on the following considerations 

  • File and directory name format: Most of the elements making up the directory and file names are either predefined name (UNMATCHED, ISO, Target) or number formats (0002, 1, 1890-10-18-01, 4000220289521). The only slightly complexed case is the newspaperID element, where the format is [a-zA-Z0-9] (this is apparently not written down anywhere).
  • The bitrepository only accepts FileIDs of the format [a-zA-Z0-9\-_.] {5,250}.

Note that the constraint on newspaperIDs must be implemented in the file structure check and shared with the MFPak people. The ingester itself also needs to protect itself from invalid newspaperIDs, as the file structure checker will only be run on the received files after ingest (should have been run at ninestars though).

  • No labels