... | @@ -121,4 +121,26 @@ Mappings apply to the individual sections of Castor import column names. If PEP |
... | @@ -121,4 +121,26 @@ Mappings apply to the individual sections of Castor import column names. If PEP |
|
|
|
|
|
If a mapping is configured, it applies to all Castor entities with the same name. For example, when Data Administrator introduces a mapping for a survey step named `Stap 2`, the mapping will also be applied to all other entities (surveys, phases, steps etc.) that are also named `Stap 2`. Data Administrator should be aware that, when a mapping is introduced, the import of multiple Castor studies and/or data types may require differently named columns.
|
|
If a mapping is configured, it applies to all Castor entities with the same name. For example, when Data Administrator introduces a mapping for a survey step named `Stap 2`, the mapping will also be applied to all other entities (surveys, phases, steps etc.) that are also named `Stap 2`. Data Administrator should be aware that, when a mapping is introduced, the import of multiple Castor studies and/or data types may require differently named columns.
|
|
|
|
|
|
Note that column name mappings are applied to [mangled](#name-mangling) names rather than raw names. Castor entities named `pésca` ("fishing") and `pèsca` ("peach") would therefore be subject to the same mapping, since both are mangled to `psca`. |
|
Note that column name mappings are applied to [mangled](#name-mangling) names rather than raw names. Castor entities named `pésca` ("fishing") and `pèsca` ("peach") would therefore be subject to the same mapping, since both are mangled to `psca`.
|
|
\ No newline at end of file |
|
|
|
|
|
# Step by step
|
|
|
|
|
|
|
|
Configuring PEP's Castor integration functionality requires multiple administrative actions, as well as data entry by assessors and/or study participants.
|
|
|
|
|
|
|
|
1. Create and configure a Castor study, e.g. using the [Castor Web interface](https://data.castoredc.com/).
|
|
|
|
2. Grant appropriate access to the Castor study @@@ which privileges? to whom? @@@
|
|
|
|
3. Have the PEP (support) team configure a short pseudonym column for the Castor study.
|
|
|
|
4. Register new participants and/or use `pepAssessor` to open existing ones to generate short pseudonyms and create corresponding Castor records.
|
|
|
|
5. Enter data into the Castor record.
|
|
|
|
6. Have the PEP (support) team configure the data type(s) to be imported from the Castor study.
|
|
|
|
7. Have Data Administrator [configure PEP columns](#column-configuration) required for the import.
|
|
|
|
8. Perform an import run.
|
|
|
|
|
|
|
|
## Column configuration
|
|
|
|
|
|
|
|
When PEP's import routine encounters Castor data, it simply attempts to store it into the appropriate column. Since the import routine cannot create the required column(s) itself, Data Administrator must have done so beforehand to prevent the import from failing:
|
|
|
|
|
|
|
|
1. Use [the `pepcli castor list-sp-columns` command](Using-pepcli#castor-list-sp-columns) with its `--imported-only` switch to determine the name(s) of short pseudonym columns bound to Castor studies.
|
|
|
|
2. Use [the `pepcli castor list-import-columns` command](Using-pepcli#castor-list-import-columns) to determine the [names of columns](#column-naming) required to import data from Castor.
|
|
|
|
3. If the column names listed in step 2 are not to your liking, use [the `pepcli castor column-name-mapping` command](Using-pepcli#castor-column-name-mapping) to define [column name mappings](column-name-mappings). Repeat steps 2 and 3 until all column names are acceptable.
|
|
|
|
4. Use [the `pepcli castor create-import-columns` command](Using-pepcli#castor-create-import-columns) to add import columns that do not yet exist. The command automatically places newly created columns into the `Castor` column group, making them writable to the import process. (Alternatively, use the `pepcli ama column` command to create and group columns manually.) |
|
|
|
\ No newline at end of file |