Running archivist_insert

Owned by Becky Oldroyd
Last updated: Feb 13, 2024
2 min read
  1. Navigate to your forked version of archivist_insert.
    1. Note: It is important to ensure that you have the most up-to-date version before you proceed. If you do not have the latest version, please re-fork the pipeline and set it up (i.e., add the variables) before you continue. See here for information on forking a pipeline.
  2. Click on the "archivist_tables" folder.
  3. Click the plus button and “Upload file” to upload each table to the folder.
    1. Note: To avoid running the pipeline automatically, add "[skip ci]" to the "Commit message" each time you upload a table. If you want to run the pipeline immediately after the final table has been uploaded, do not add "[skip ci]" to the "Commit message" box. 
  4. To run the pipeline, either do not add "[skip ci]" to the "Commit message" box after uploading the final table, or navigate to the left-hand menu and select Build > Pipelines > Run pipeline.

 

5. If the pipeline passes, no further action is needed and the XML file can be downloaded as an "artifact" (a zip files containing the generated XML) which this is available for 10 days. The XML can be viewed temporarily from the build Archivist and can be loaded into Archivist via import. 

a. Note: Before the questionnaire is imported into Archivist, please check the questionnaire to ensure that it is ready to be worked on. Do not work on the questionnaire whilst it is in the build Archivist - please wait until it is in the correct instance of Archivist.

6. If the pipeline does not pass, click on the "cross" to identify the issue. 

                                      

                                          

a. If the csv files have a formatting problem, it will not pass stage 1 (run_tests). Make sure all the tables are compliant with the correct format - see the Creating tables page for information on how the tables should be formatted.

                                       

b. Having extra spaces on the uploaded table creates issues - delete the extra spaces and run the pipeline again to fix this error.

                              

c. Once the errors have been identified and resolved, the pipeline should run and you can download the XML and view the questionnaire in build Archivist.