UCL Logo
The Wiki will be upgraded to version 6.3 in early August - exact dates will be announced shortly. Please see the 6.0 Release notes and 6.3 Release notes for info on new features.
Page tree
Skip to end of metadata
Go to start of metadata

This page is still under construction.

The process can be less manual by using the .txt files described below. The format specifications are given at the end of the page, along with examples.

  • mapper.txt Question and sequence list produced by Archivist 
  • qvmapping.txt Mapping file which links questions and variables (listing all variables and derived variables)
  • dv.txt Mapping file which links derived variables to variables
  • tqlinking.txt Mapping file which links topics and questions
  • tvlinking.txt Mapping file which links topics and variables

A question list can be saved as a .txt from Archivist by navigating to the instrument view and then adding /mapper.txt to the web address e.g.https://archivist.closer.ac.uk/instruments/alspac_01_rat/mapper.txt

The following steps can be used to upload mappings via the .txt files.

1)      Import the sledgehammer xml

Check whether a dataset has been uploaded by searching the main Datasets page, if not upload the xml file. Admin > Import. Under Upload DDI Dataset files, browse and Import Dataset. This might take a while to appear in the Datasets list.

Note: The prefix used when running Sledgehammer must be identical to the instrument prefix. This must be checked carefully as otherwise this will mean mappings will have to be redone.

Note: DDI-Flavour must be run first.

Note: This step is currently run by the CLOSER team, as the dataset needs to be linked with the instrument, which is a feature yet to be added to Archivist.

2)      Import the variable mappings

Admin > Datasets > search for the loaded dataset (prefix or dataset name) > Import Mappings. Both the tvlinking.txt and the dv.txt can be imported. If uploading more mapping files, these will not replace those already mapped, but will add any additional mappings.

3)      Import the question mappings

Admin > Instruments > search for the questionnaire prefix > Import Mappings. Both the qvmapping.txt and tqlinking.txt can be imported. If uploading more mapping files, these will not replace those already mapped, but will add any additional mappings.

4)     Check the mappings in both the dataset and instrument view.

Admin > Datasets > search and select the Name of the dataset.  Any mapping conflicts will appear in red.

The Q-V mappings can also be checked through Admin > Instruments > search and select the Prefix of the instrument. This will gives the questionnaire view with the variable names listed against them

Note: Variables can be mapped to grid references in the qvmapping.txt file, but currently these will only be displayed as mapped to the gird as a whole.

Format specifications:


  • ID (qc or URN)
  • Type (“Question” or “Sequence”)
  • Grid limits or “-“ for null ([Y,X])
  • Parent (URN)
  • Text (Literal or Sequence name)


  • Tab delimited
  • Must include all variables including derived variables
  • 2 columns
    • qc
      • Question name
      • ‘0’ if mapped to nothing
      • ‘0’ if derived variable
      • [OPTIONAL] suffix grid cell coordinates in the format $X;Y. Please refer to the Grid coordinates table on the condition page for how to reference grid cells.
    • Variable name


  • Configuration file
  • Tab delimited
  • Used for applying level 1 & 2 topics to variables
  • Uses Colecitca topics IDs
  • 2 columns


  • Tab delimited
  • Uses Colecitca topics IDs
  • 2 columns


  • Tab delimited
  • Only includes derived variables
  • 2 columns
    • Derived variable name
    • Source variable name


  • No labels