Skip to content

Changes

Page history
Update Getting started with the toolkit authored by Nick Bywell's avatar Nick Bywell
Hide whitespace changes
Inline Side-by-side
Getting-started-with-the-toolkit.md
View page @ 37355980
......@@ -216,15 +216,13 @@ This section is not mandatory.
Run the script “gfs_create_arkivum_upload.py” to create the upload package.
python H:\lse_digital_toolkit\gfs_create_arkivum_upload.py y y "Z:\GFS\\\<organisation code>\\\<department code>\\\<project code>\001" preservation_and_access default pdf
python H:\lse_digital_toolkit\gfs_create_arkivum_upload.py y y "Z:\GFS\\\<organisation code>\\\<department code>\\\<project code>\001" pres_and_acc default pdf
The start of the output to the command window when the script is executed should look similar to that indicated in this screenshot:
Note that "pres_and_acc" indicates that the resultant file will be uploaded to the "preservation_and_access" datapool.
![Example_start_of_tranche_upload_script_report](uploads/1c4ac7bf203ab05b983e082e3bebeb77/Example_start_of_tranche_upload_script_report.png)
The output to the command window when the script is executed should look similar to that indicated in this screenshot:
The end of the output to the command window when the script is executed should look similar to that indicated in this screenshot:
![Example_end_of_tranche_upload_script_report](uploads/695bad9945830d58f0fd8a274f378287/Example_end_of_tranche_upload_script_report.png)
![Example_tranche_upload_script_report](uploads/b99aaea64f470c940487facdd57f0aad/Example_tranche_upload_script_report.png)
There will be output of the form indicated below produced for each child folder:
......@@ -232,15 +230,15 @@ INFO: Processing parent folder: x child folder y
The upload-package-container-folder will be created automatically within the project folder. The upload-package-container-folder will have the following path:
Z:\GFS\\\<organisation code>\\\<department code>\\\<project code>\arkivum_v6_<organisation code>_<department code>_<project code>_001_preservation_and_access
Z:\GFS\\\<organisation code>\\\<department code>\\\<project code>\arkivum_v6_<organisation code>_<department code>_<project code>_001_pres_and_acc
Within this folder can be found a zip file:
"arkivum_v6_<organisation code>_<department code>_<project code>_001_preservation_and_access_upload.zip"
"arkivum_v6_<organisation code>_<department code>_<project code>_001_pres_and_acc_upload.zip"
This is the zip file that can be uploaded to Perpetua.
As "preservation_and_access" was specified on the command line, before uploading the file, a corresponding slug would be entered manually into the AtoM module. The slug that should be entered manually into AtoM can be found in the second row of the "atom.qubitParentSlug" column in the metadata.csv file that is contained in the upload zip file.
As "pres_and_acc" was specified on the command line, before uploading the file, a corresponding slug would be entered manually into the AtoM module. The slug that should be entered manually into AtoM can be found in the second row of the "atom.qubitParentSlug" column in the metadata.csv file that is contained in the upload zip file.
If using the default configuration, the slug will take the form "<organisation code>-<department code><project code>". Using the value that was automatically created in the metadata.csv as a slug will ensure that the naming conventions present in the records of the AtoM module are consistent with those in the GFS.
......@@ -250,7 +248,7 @@ The way in which the tranche in the example GFS displays when uploaded to Perpet
A successful upload of this zip file will only occur if the content of the metadata.csv file matches the way in which the user's Perpetua instance has been configured. It will be necessary to contact Arkivum Technical Support to ensure that this is the case.
The composition of the metadata.csv file can be controlled by editing the “gfs_arkivum_column_header_info.csv” configuration file. Details of how to configure the toolkit can be found in the [Configuration](https://itsagit.lse.ac.uk/nub/lse_digital_toolkit/-/wikis/Configuration) section.
The composition of the metadata.csv file can be controlled by editing the “gfs_arkivum_column_header_info.csv” configuration file. Details of how to configure the toolkit can be found in the [Configuration](https://itsagit.lse.ac.uk/hub/lse_digital_toolkit/-/wikis/Configuration) section.
## 14. Tidying up your GFS
......