Git Product home page Git Product logo

data_curator_config's Introduction

Project configurations for the Data Curator App

The file 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.\

Each DCC will have its own directory to store configuration files. At minimum it will have dca_config.json. This file can be validated against schemas/dca_config.schema.json. At the top level it contains three json objects, dcc, dca, and schematic.\

dcc contains various configurations about your DCC and data model:\

  • name - name of DCC in dropdown menu
  • synapse_asset_view - synapse ID of asset view.
  • data_model_url - data model URL (RAW github file).
  • data_model_info - URL to a description of the data model, such as release notes.
  • template_menu_config_file - URL to DCA template dropdown file.
  • logo_location - URL to logo file.
  • logo_link - link to DCC website.
  • dcc_help_link - link for users to find help about DCA.
  • portal_help_link - link for users to find help about their portal.

dca contains DCA-specific customizations:\

  • use_compliance_dashboard - TRUE or FALSE. Only FALSE currently supported. Data compliance dashboard.
  • primary_col - center header color hex code.
  • secondary_col - right header color hex code.
  • sidebar_col - left header color hex code.

schematic contains several objects for passing parameters to schematic commands:\

Each DCC also needs a template configuration file. This controls which data types are accessible to users and if they contain record-based or file-based data. It can be generated by hand or automatically from a data model using the dca-template-config-action github action. See an example workflow in a data model repo. This json file can be validated against schemas/dca_template_config.schema.json. The top level of the file needs a json array of objects named manifest_schemas. Each object in the array requires:

  • display_name: Display name of the data type
  • schema_name: Name of the schema
  • type: record or file
  • project_scope: Array of Synapse IDs for cross manifest validation. Optional.

Project scope is only needed for data types that use cross manifest validation. In most cases it can be ommitted.

See our example dca_template_config.json

data_curator_config's People

Contributors

afwillia avatar adamjtaylor avatar github-actions[bot] avatar nlee-sage avatar anngvu avatar cconrad8 avatar allaway avatar avanlinden avatar danlu1 avatar aditigopalan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.