Skip to content

Commit

Permalink
WIP: update README for new config
Browse files Browse the repository at this point in the history
  • Loading branch information
afwillia committed Nov 16, 2023
1 parent b880d2a commit fd20c4e
Showing 1 changed file with 31 additions and 22 deletions.
53 changes: 31 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,35 @@
# Project configurations for the [Data Curator App](github.com/sage-Bionetworks/data_curator)
# DCC configurations for the [Data Curator App](github.com/sage-Bionetworks/data_curator)

Each project or DCC needs the following for DCA:
- A record in [dcc_config.csv](dcc_config.csv).
- A project folder in this repo containing at minimum [dca-template-config.json](demo/dca-template-config.json) for the project's data model.
The file [tenants.json](tenants.json) controls which DCCs appear in DCA. It contains a json object `tenants` which holds one json object per DCC. Each DCC object requires:\

- `name`: The name of the DCC to appear in the DCA selection menu\
- `synapse_asset_view`: The synapse ID of the DCCs fileview for DCA. Must include "syn"\
- `config_location`: Filepath to the DCC's DCA config file. More details below.\

The file [dca_config.json](test/smoke_test_dca_config.json) contains all of the DCA
configurations for a DCC. It can be validated against [dca_config.schema.json](schemas/dca_config.schema.json).

Each project or DCC needs the following for DCA:\
- A record in [dcc_config.csv](dcc_config.csv).\
- A project folder in this repo containing at minimum [dca-template-config.json](demo/dca-template-config.json) for the project's data model.

The project-specific folder contains at minimum [dca-template-config.json](demo/dca-template-config.json) to specify which data model components can be selected by users in DCA. This file can be created automatically by this repo's [generate_templates workflow](.github/workflows/generate_templates.yml). This will create a PR with the file where users can edit it manually if needed.

[dcc_config.csv](dcc_config.csv) allows users to configure project information, [Schematic options](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html), aesthetics. The fields are:
- `project_name` - name of DCC in dropdown menu
- `synapse_asset_view` - synapse ID of asset view.
- `data_model_url` - data model URL (**RAW** github file).
- `template_menu_config_file` - path to DCA template dropdown file in repo.
- `logo_location` - path to logo file in repo. Optional.
- `logo_link` - link to DCC website. Optional.
- `manifest_output_format` - `excel` or `google_sheets`. [Schemtic manifest get option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-manifest-get).
- `manifest_use_annotations` - `TRUE` or `FALSE`. [Schemtic manifest get option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-manifest-get).
- `validate_restrict_rules` - `TRUE` or `FALSE`. [Schematic model validate and submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-validate).
- `submit_use_schema_labels` - `TRUE` or `FALSE`. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).
- `submit_table_manipulation` - `replace` or `upsert`. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).
- `submit_manifest_record_type` - One of `table_and_file`, `file_only` , `file_and_entities` or `table_file_and_entities`. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).
- `submit_hide_blanks` - `TRUE` or `FALSE`. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).
- `use_compliance_dashboard` - `TRUE` or `FALSE`. Only FALSE currently supported. Data compliance dashboard.
- `primary_col` - center header color hex code. Optional.
- `secondary_col` - right header color hex code. Optional.
- `sidebar_col` - left header color hex code. Optional.
[dcc_config.csv](dcc_config.csv) allows users to configure project information, [Schematic options](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html), aesthetics. The fields are:\
- `project_name` - name of DCC in dropdown menu\
- `synapse_asset_view` - synapse ID of asset view.\
- `data_model_url` - data model URL (**RAW** github file).\
- `template_menu_config_file` - path to DCA template dropdown file in repo.\
- `logo_location` - path to logo file in repo. Optional.\
- `logo_link` - link to DCC website. Optional.\
- `manifest_output_format` - `excel` or `google_sheets`. [Schemtic manifest get option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-manifest-get).\
- `manifest_use_annotations` - `TRUE` or `FALSE`. [Schemtic manifest get option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-manifest-get).\
- `validate_restrict_rules` - `TRUE` or `FALSE`. [Schematic model validate and submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-validate).\
- `submit_use_schema_labels` - `TRUE` or `FALSE`. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).\
- `submit_table_manipulation` - `replace` or `upsert`. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).\
- `submit_manifest_record_type` - One of `table_and_file`, `file_only` , `file_and_entities` or `table_file_and_entities`. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).\
- `submit_hide_blanks` - `TRUE` or `FALSE`. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).\
- `use_compliance_dashboard` - `TRUE` or `FALSE`. Only FALSE currently supported. Data compliance dashboard.\
- `primary_col` - center header color hex code. Optional.\
- `secondary_col` - right header color hex code. Optional.\
- `sidebar_col` - left header color hex code. Optional.

0 comments on commit fd20c4e

Please sign in to comment.