... | ... | @@ -60,8 +60,8 @@ The command also allows participant groups (as opposed to individual participant |
|
|
Whatever data is downloaded, the `pepcli pull` command writes it to a directory tree with the following structure:
|
|
|
|
|
|
- A top level directory for the download, containing:
|
|
|
- One subdirectory per participant (named after the participant's [local pseudonym](Pseudonymization#identifiers-in-pep)), containing:
|
|
|
- One file per cell downloaded for this participant. The file is named after the column.
|
|
|
- One subdirectory per data subject (named after the subject's [local pseudonym](Pseudonymization#identifiers-in-pep)), containing:
|
|
|
- One file per cell downloaded for this subject. The file is named after the column.
|
|
|
|
|
|
By default the top level directory is named `pulled-data` and placed into the current working directory. This behavior can be overridden by means of the `-o` switch, e.g.:
|
|
|
|
... | ... | @@ -84,6 +84,40 @@ Use the `--force` switch to have the command (discard/overwrite local data and) |
|
|
|
|
|
## Manually `list`ing and `get`ting data
|
|
|
|
|
|
As [described](#downloading-data), the `pepcli pull` command downloads data into a predefined local directory structure. Users that need more fine-grained control over the download process can use the `pepcli list` and `pepcli get` commands instead.
|
|
|
|
|
|
### `List`ing data
|
|
|
|
|
|
The [`pepcli list` command](Using-pepcli#list) accepts the same switches as the `pepcli pull` command to specify the participants, participant groups, columns, and column groups that the user is interested in. E.g.:
|
|
|
|
|
|
```
|
|
|
/app/pepcli list -P all-pit -P all-denovo -C DeNovoWatchData -C Castor -c IsTestParticipant
|
|
|
```
|
|
|
|
|
|
By default the `pepcli list` command will
|
|
|
|
|
|
- immediately retrieve data that is smaller than 1000 bytes and include it in the output. This so-called *inlining* behavior can be overridden by means of the `--inline-data-size-limit` and `--no-inline-data` switches. The command's output will include identifiers for any data that is not inlined.
|
|
|
- omit local pseudonyms from the output. The inclusion of local pseudonyms can be requested by means of the `--local-pseudonyms` switch.
|
|
|
- output data in the order in which it is received from the PEP servers. Use the `--group-output` switch to have entries for the same data subject grouped into a single node.
|
|
|
- request a ticket and use it exclusively for its own data retrieval. This behavior can be overridden using the `--ticket` and `--ticket-out` switches.
|
|
|
|
|
|
The `pepcli list` command produces output in a [JSON](https://www.json.org/json-en.html) structure representing the data available in PEP:
|
|
|
|
|
|
- A top level JSON array, containing
|
|
|
- An (unnamed) object containing
|
|
|
- A node named `pp`, containing the subject's [polymorphic pseudonym](Pseudonymization#identifiers-in-pep).
|
|
|
- If requested, a node named `lp`, containing the subject's [local pseudonym](Pseudonymization#identifiers-in-pep).
|
|
|
- A node named `data` with an object value representing data that was inlined. Within the object:
|
|
|
- Node names correspond with column names.
|
|
|
- Node values contain the (raw) inlined data retrieved from PEP.
|
|
|
- A node named `ids` with an object value representing data that was not inlined. Within the object:
|
|
|
- Node names correspond with column names.
|
|
|
- Node values contain the data's identifier, which can be [passed to the `pepcli get` command](#getting-data).
|
|
|
|
|
|
@@@ more here @@@
|
|
|
|
|
|
### `Get`ting data
|
|
|
|
|
|
@@@ more here @@@
|
|
|
|
|
|
## 2. List data from PEP e.g. to retrieve a short pseudonym
|
... | ... | |