... | ... | @@ -39,7 +39,7 @@ pepcli ama query --column-group ShortPseudonyms # The completed command line |
|
|
|
|
|
The commands supported by `pepcli` are listed below. Follow hyperlinks to read more detailed documentation on each of the commands.
|
|
|
|
|
|
- [`ama`](#ama) performs administrative tasks related to the Access Manager service.
|
|
|
- [`ama`](#ama) provides subcommands to perform administrative tasks related to the Access Manager service.
|
|
|
- [`get`](#get) retrieves data from a specific cell.
|
|
|
- [`list`](#list) lists data available in PEP.
|
|
|
- [`pull`](#pull) stores a data set in files on your local machine.
|
... | ... | @@ -63,7 +63,7 @@ Data storage and retrieval: |
|
|
|
|
|
Administrative tasks:
|
|
|
|
|
|
- [`ama`](#ama) performs administrative tasks related to the Access Manager service.
|
|
|
- [`ama`](#ama) provides subcommands to perform administrative tasks related to the Access Manager service.
|
|
|
|
|
|
## General flags
|
|
|
|
... | ... | @@ -85,17 +85,40 @@ Other general flags exist, but are intended for use by developers of the PEP sys |
|
|
|
|
|
## `ama`
|
|
|
|
|
|
The `ama` command's various sub-commands can be used to perform administrative tasks. While `ama` is short for "Access Manager Administration", it should be noted that the `ama` command is not aimed exclusively at the "access administrator", i.e. the role responsible for access management. Several sub-commands are intended for use by a "data administrator" instead.
|
|
|
The `ama` command's various sub-commands can be used to perform administrative tasks. While `ama` is short for "Access Manager Administration", it should be noted that `ama` provides subcommands for both the `Access Administrator` and `Data Administrator` roles. Users must be enrolled for the role appropriate for the subcommand they're invoking.
|
|
|
|
|
|
### `ama column`
|
|
|
|
|
|
The `column` subcommand allows `Data Administrator` to create and remove columns:
|
|
|
|
|
|
```
|
|
|
pepcli ama column create <column name>
|
|
|
pepcli ama column remove <column name>
|
|
|
```
|
|
|
|
|
|
Note that column removal will not discard data present in those columns. Therefore:
|
|
|
|
|
|
- when users retrieve data from an earlier moment in time, those data may include columns that have since been removed.
|
|
|
- when a column is removed and later re-added, the newly added column will contain any data that had previously been stored in the same column name.
|
|
|
|
|
|
The `column` subcommand can also be used to group and un-group columns into column groups:
|
|
|
|
|
|
```
|
|
|
pepcli ama column addTo <column name> <column group name>
|
|
|
pepcli ama column removeFrom <column name> <column group name>
|
|
|
```
|
|
|
|
|
|
Such column groups are used by `Access Administrator` to [provide data access to users](Access-control#access-rules).
|
|
|
|
|
|
### `ama query`
|
|
|
|
|
|
The `query` subcommand summarizes the current state of PEP's [data structure](Data-structure) and [access rules](Access-control#access-rules).
|
|
|
The `query` subcommand summarizes the current state of PEP's [data structure](Data-structure) and [access rules](Access-control#access-rules). Both the `Access Administrator` and `Data Administrator` roles can invoke this subcommand:
|
|
|
|
|
|
```
|
|
|
pepcli ama query
|
|
|
```
|
|
|
|
|
|
This subcommand's output lists
|
|
|
This output lists
|
|
|
|
|
|
- The `Columns` that have been defined by data administrator.
|
|
|
- The `ColumnGroups` that have been defined by data administrator, and the columns included in each column group.
|
... | ... | |