How to submit a datapackage - nih-cfde/published-documentation GitHub Wiki

  1. Install the cfde-submit tool in a virtual environment as recommended.
  2. Your DCC needs to be registered in the portal and have the correct permissions set up to be able to submit datapackages. The OnBoarded DCC page in the portal lists all the registered DCCs. Contact the helpdesk: [email protected] to register your DCC if not on the list.
  3. The cfde-submit requires the DCC's unique identifier for making submission. You can find your DCC's identifier in the OnBoarded DCC page. The tool will take cfde_registry_dcc:dcc_name or dcc_name where dcc_name is replaced by short form of your DCC's name.
  4. First step for submission is authorization. Enter the following command: cfde-submit login
  5. A browser will automatically open with a Globus page requesting permission for CFDE Native App. Click "Allow". When using cfde-submit on a remote machine not associated with a web browser, a web address is displayed. Copy and paste the web address in a web browser and login if prompted using the same credentials used for setup. Copy and paste the code from the web browser back to the shell to complete login.
  6. Successful login will result in a You are authenticated and your tokens have been cached. message on the prompt.
  7. Submit your instance: cfde-submit run DATA-PATH [OPTIONS], where DATA-PATH is the path to the directory where your C2M2 instance is located. Find out more about the different options on the documentation page.
  8. The cfde-submit run will exit after your C2M2 instance has been uploaded. To check the status of the ingest process use: cfde-submit status [OPTIONS]. You can specify either the particular submission or the Flow ID using the options flag.
  9. To view the submission, go to https://app.nih-cfde.org/ and click on For Submitters tab and choose List all Submissions. Your latest submission should appear on top of the list. The Ingest Status located under Status Summary will indicate the status of your submission.
  10. Successful submission with results in the Ingest Status being updated to content ready for review and the appearance of links to "Browse Data" and "Summary Charts" in the Review Content row at the bottom of the first column.