Difference between revisions of "SIP Structure"

From Archivematica
Jump to navigation Jump to search
(Expand magic files list)
(More details, formatting)
Line 1: Line 1:
 
[[Main Page]] > [[Development]] > [[:Category:Development documentation]] > SIP Structure
 
[[Main Page]] > [[Development]] > [[:Category:Development documentation]] > SIP Structure
  
−
A Transfer or SIP in Archivematica has a number of special directories and files that will trigger specific workflows.
+
A Transfer or SIP in Archivematica has a number of special directories and files.  Many of these are created by Archivematica, and should not be submitted by users.  Others will trigger specific workflows if included in the transfer.
−
 
 
−
 
 
  
 
{|
 
{|
Line 9: Line 7:
 
!Path
 
!Path
 
!File or Folder?
 
!File or Folder?
 +
!Source?
 
!Usage
 
!Usage
 
|-
 
|-
−
|/SIP_Folder
+
|<code>/SIP_Folder</code>
 
|folder
 
|folder
 +
|User
 
|Top level container for the the SIP
 
|Top level container for the the SIP
 
|-
 
|-
−
|/SIP_Folder/DIP
+
|<code>/SIP_Folder/DIP</code>
 
|folder
 
|folder
−
|Created by Archivematica for the DIP
+
|Archivematica
 +
|This will become the DIP
 
|-
 
|-
−
|/SIP_Folder/DIP/objects
+
|<code>/SIP_Folder/DIP/objects</code>
 
|folder
 
|folder
−
|Created by Archivematica and contains the access objects
+
|Archivematica
 +
|Contains the access derivatives
 
|-
 
|-
−
|/SIP_Folder/DIP/thumbnails
+
|<code>/SIP_Folder/DIP/thumbnails</code>
 
|folder
 
|folder
−
|Created by Archivematica for thumbnails for the DIP objects
+
|Archivematica
 +
|Contains thumbnails for the DIP
 
|-
 
|-
−
|/SIP_Folder/logs
+
|<code>/SIP_Folder/logs</code>
 
|folder
 
|folder
−
|Created by Archivematica for log files generated by Archivematica
+
|Archivematica
 +
|Log files generated by Archivematica
 
|-
 
|-
−
|/SIP_Folder/logs/fileMeta
+
|<code>/SIP_Folder/logs/fileMeta</code>
 
|folder
 
|folder
−
|???
+
|User
 +
|Uncertain, used in the TRIM workflow
 
|-
 
|-
−
|/SIP_Folder/metadata
+
|<code>/SIP_Folder/metadata</code>
 
|folder
 
|folder
−
|Metadata files provided by the user or created by Archivematica
+
|User
 +
|Metadata files provided by the user. Depending on the file, these may be processed by Archivematica.
 
|-
 
|-
−
|/SIP_Folder/metadata/checksums.md5
+
|<code>/SIP_Folder/metadata/checksum.md5</code>
 
|text file
 
|text file
−
|User-provided checksums for original files. Format is the same as the output of <code>md5deep -rl objects/</code>. Also supported: <code>checksums.sha1</code> and <code>checksums.sha256</code>
+
|User
 +
|External checksums for original files. Format is the same as the output of <code>md5deep -rl objects/</code>. Also supported: <code>checksums.sha1</code> and <code>checksums.sha256</code>
 
|-
 
|-
−
|/SIP_Folder/metadata/file_labels.csv
+
|<code>/SIP_Folder/metadata/file_labels.csv</code>
 
|CSV file
 
|CSV file
−
|???
+
|User
 +
|Labels for files in the METS structMap
 
|-
 
|-
−
|/SIP_Folder/metadata/metadata.csv
+
|<code>/SIP_Folder/metadata/metadata.csv</code>
 
|CSV file
 
|CSV file
−
|User-provided file-level DublinCore metadata
+
|User
 +
|File-level DublinCore metadata
 
|-
 
|-
−
|/SIP_Folder/metadata/metadata.json
+
|<code>/SIP_Folder/metadata/metadata.json</code>
 
|JSON file
 
|JSON file
−
|User-provided file-level DublinCore metadata formatted as JSON. Will be converted to a CSV during processing
+
|User
 +
|File-level DublinCore metadata formatted as JSON. Will be converted to a CSV during processing
 
|-
 
|-
−
|/SIP_Folder/METS.sip-uuid.xml
+
|<code>/SIP_Folder/METS.sip-uuid.xml</code>
 
|XML file
 
|XML file
−
|Created by Archivematica with all of the metadata on the METS
+
|Archivematica
 +
|Contains all of the metadata on the METS
 
|-
 
|-
−
|/SIP_Folder/objects
+
|<code>/SIP_Folder/objects</code>
 
|folder
 
|folder
−
|Original objects provide by the user. If this directory doesn't exist, all files in /SIP_Folder will be moved here by Archivematica
+
|User or Archivematica
 +
|Original objects provide by the user. If this directory doesn't exist, all files in <code>/SIP_Folder</code> will be moved here by Archivematica
 
|-
 
|-
−
|/SIP_Folder/objects/access
+
|<code>/SIP_Folder/objects/access</code>
 
|folder
 
|folder
−
|Triggers access workflow. Deprecated in favor of manual normalization workflow.
+
|User
 +
|Triggers manually created access derivatives workflow, which is deprecated in favor of manual normalization workflow.
 
|-
 
|-
−
|/SIP_Folder/objects/manualNormalization/normalization.csv
+
|<code>/SIP_Folder/objects/manualNormalization/normalization.csv</code>
 
|CSV file
 
|CSV file
−
|User-provided CSV that provides a mapping for original objects of the same name to their access and preservation derivatives
+
|User
 +
|CSV that provides a mapping for original objects of the same name to their access and preservation derivatives in manual normalization.
 
|-
 
|-
−
|/SIP_Folder/objects/manualNormalization/access
+
|<code>/SIP_Folder/objects/manualNormalization/access</code>
 
|folder
 
|folder
 +
|User
 
|Access derivatives created outside of Archivematica. Should have the same filename as the original, but may have a different extension
 
|Access derivatives created outside of Archivematica. Should have the same filename as the original, but may have a different extension
 
|-
 
|-
−
|/SIP_Folder/objects/manualNormalization/preservation
+
|<code>/SIP_Folder/objects/manualNormalization/preservation</code>
 
|folder
 
|folder
 +
|User
 
|Preservation derivatives created outside of Archivematica. Should have the same filename as the original, but may have a different extension
 
|Preservation derivatives created outside of Archivematica. Should have the same filename as the original, but may have a different extension
 
|-
 
|-
−
|/SIP_Folder/service
+
|<code>/SIP_Folder/objects/service</code>
 
|folder
 
|folder
−
|User-provided service files. Normalization can be performed on these files instead of the originals
+
|User
 +
|Service files - cleaned up versions of the original that are not derivatives. Normalization can be performed on these files instead of the originals
 +
|-
 +
|<code>/SIP_Folder/processingMCP.xml</code>
 +
|XML file
 +
|Archivematica or user
 +
|Automates workflow decisions. Created by Archivematica, but can be submitted as part of the Transfer to override the default pipeline workflow choices.
 
|-
 
|-
−
|/SIP_Folder/submissionDocumentation
+
|<code>/SIP_Folder/submissionDocumentation</code>
 
|folder
 
|folder
−
|Folder for user-provided files that are not original objects but should still be in the AIP
+
|User
 +
|Folder for files that are not original objects but should still be in the AIP
 
|-
 
|-
−
|/SIP_Folder/thumbnails
+
|<code>/SIP_Folder/thumbnails</code>
 
|folder
 
|folder
−
|Created by Archivematica for thumbnail derivatives
+
|Archivematica
 +
|Contains thumbnail derivatives
 
|}
 
|}
  

Revision as of 17:57, 30 March 2017

Main Page > Development > Category:Development documentation > SIP Structure

A Transfer or SIP in Archivematica has a number of special directories and files. Many of these are created by Archivematica, and should not be submitted by users. Others will trigger specific workflows if included in the transfer.

Path File or Folder? Source? Usage
/SIP_Folder folder User Top level container for the the SIP
/SIP_Folder/DIP folder Archivematica This will become the DIP
/SIP_Folder/DIP/objects folder Archivematica Contains the access derivatives
/SIP_Folder/DIP/thumbnails folder Archivematica Contains thumbnails for the DIP
/SIP_Folder/logs folder Archivematica Log files generated by Archivematica
/SIP_Folder/logs/fileMeta folder User Uncertain, used in the TRIM workflow
/SIP_Folder/metadata folder User Metadata files provided by the user. Depending on the file, these may be processed by Archivematica.
/SIP_Folder/metadata/checksum.md5 text file User External checksums for original files. Format is the same as the output of md5deep -rl objects/. Also supported: checksums.sha1 and checksums.sha256
/SIP_Folder/metadata/file_labels.csv CSV file User Labels for files in the METS structMap
/SIP_Folder/metadata/metadata.csv CSV file User File-level DublinCore metadata
/SIP_Folder/metadata/metadata.json JSON file User File-level DublinCore metadata formatted as JSON. Will be converted to a CSV during processing
/SIP_Folder/METS.sip-uuid.xml XML file Archivematica Contains all of the metadata on the METS
/SIP_Folder/objects folder User or Archivematica Original objects provide by the user. If this directory doesn't exist, all files in /SIP_Folder will be moved here by Archivematica
/SIP_Folder/objects/access folder User Triggers manually created access derivatives workflow, which is deprecated in favor of manual normalization workflow.
/SIP_Folder/objects/manualNormalization/normalization.csv CSV file User CSV that provides a mapping for original objects of the same name to their access and preservation derivatives in manual normalization.
/SIP_Folder/objects/manualNormalization/access folder User Access derivatives created outside of Archivematica. Should have the same filename as the original, but may have a different extension
/SIP_Folder/objects/manualNormalization/preservation folder User Preservation derivatives created outside of Archivematica. Should have the same filename as the original, but may have a different extension
/SIP_Folder/objects/service folder User Service files - cleaned up versions of the original that are not derivatives. Normalization can be performed on these files instead of the originals
/SIP_Folder/processingMCP.xml XML file Archivematica or user Automates workflow decisions. Created by Archivematica, but can be submitted as part of the Transfer to override the default pipeline workflow choices.
/SIP_Folder/submissionDocumentation folder User Folder for files that are not original objects but should still be in the AIP
/SIP_Folder/thumbnails folder Archivematica Contains thumbnail derivatives
Retrieved from "https://wiki.archivematica.org/index.php?title=SIP_Structure&oldid=11788"