Changes for page Working with HDC Project Files in the Command Line Interface

Last modified by Dennis Segebarth on 2024/10/02 18:38

From 1.4 to 1.5 From 1.6 to 1.7

From version 1.5

edited by Susan Evans
on 2023/07/10 22:20

Change comment: (Autosaved)

To version 1.6

edited by Susan Evans
on 2023/07/10 22:22

Change comment: (Autosaved)

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -511,10 +511,85 @@
  In order to upload a file (or folder) to a destination directory in a Project's Core, core must be specified as corresponding zone {{code}}(-z core){{/code}} and you will be required to provide a message to that should describe the files` content and why you are uploading it directly into the Core {{code}}(-m "sample message"){{/code}}. Moreover, you will be reminded about the Terms of Use of the Platform and additional considerations regarding the direct upload of data into the Core zone, and are prompted to confirm your intention to proceed with the upload by entering “y” or “Yes”:
++{{code language="none"}}
++$ pilotcli file upload ./sample_folder/sample_file2 -p cli/admin -z core -m "sample message"
++You are about to transfer data directly to the Core! In accordance with the Terms of Use, please confirm that you
++have made your best efforts to pseudonymize or anonymize the data and that you have the legal authority to transfer and make this
++data available for dissemination and use within the Platform.To review the Terms of Use, please the Portal. If you
++need to process the data to remove sensitive identifiers, please cancel this transfer and upload the data to the Green Room to
++perform these actions.
++To cancel this transfer, enter [n/No]
++To confirm and proceed with the data transfer, enter [y/Yes]
++  [y/N]: y
++Starting upload of: ./sample_folder/sample_file2
++Pre-upload complete.
++uploader: admin container_id: 18061 total_size: 1048576 total_chunks: 1 uniq_identifier: fa807a0f-ceb0-4fff-9c9e-563bdcbb309f-1627498851 resumable_relative_path admin/
++
++Upload job is finalizing, please wait...
++Upload job complete.
++All files uploaded successfully.
++{{/code}}
++Upload a folder to Project Green Room
++{{code language="none"}}
++$ pilotcli file upload ./sample_folder/example_folder -p cli/admin
++Starting upload of: ./sample_folder/example_folder
++Current version does not support folder tagging, any selected tags will be ignored
++Pre-upload complete.
++uploader: admin container_id: 18061 total_size: 1048576 total_chunks: 1 uniq_identifier: 4f0eee2e-70f4-4b03-9e72-040544ec7d3a-1627498907 resumable_relative_path admin/example_folder/
++
++Starting finalization...
++uploader: admin container_id: 18061 total_size: 1048576 total_chunks: 1 uniq_identifier: 41ec70e2-0859-4aba-9009-06e700c7c79e-1627498907 resumable_relative_path admin/example_folder/
++
++Starting finalization...
++uploader: admin container_id: 18061 total_size: 1048576 total_chunks: 1 uniq_identifier: 28454c51-ec9a-4dc5-ab3c-0f7e80e3050d-1627498907 resumable_relative_path admin/example_folder/
++
++Upload job is finalizing, please wait...
++Upload job complete.
++All files uploaded successfully.
++{{/code}}
++Upload file to existing folder in Green Room
++* Specify a target folder to upload files by inputting folder name after the Project code separated by the '/'.
++
++{{code language="none"}}
++$ pilotcli file upload ./sample_folder/sample_file5 -p cli/admin/example_folder
++Starting upload of: ./sample_folder/sample_file5
++Pre-upload complete.
++uploader: admin container_id: 18061 total_size: 1048576 total_chunks: 1 uniq_identifier: 7ef58005-d408-4ad9-a741-fa938f58e67f-1627498977 resumable_relative_path admin/example_folder/
++
++Upload job is finalizing, please wait...
++Upload job complete.
++All files uploaded successfully.
++{{/code}}
++
++Upload folder as zip to a specified directory of a Project's Green Room by adding the ~-~-zip option.
++
++* The specified folder will then be compressed as a zip file and subsequently be uploaded to the specified destination. Once the upload is completed, the compressed zip file will be removed from the directory. Note: pilotcli must have the permission to create and delete zip files in the corresponding directory of your local machine:
++
++{{code language="none"}}
++$ pilotcli file upload ./sample_folder/example_folder -p cli/admin --zip
++Starting upload of: ./sample_folder/example_folder
++Started zipping files.
++Pre-upload complete.
++uploader: admin container_id: 18061 total_size: 3595 total_chunks: 1 uniq_identifier: 61a729ce-cdd6-4a87-82b5-3f8ea63e6c4a-1627499012 resumable_relative_path admin/
++
++Upload job is finalizing, please wait...
++Upload job complete.
++All files uploaded successfully.
++{{/code}}
++
++Upload a file with tags and/or attributes.
++
++* When entering the upload command, the user can add a maximum of ten tags to the file. For example, in order to add “sample_tag1” and “sample_tag2” to your file, simply add {{code}}-t sample_tag1{{/code}} {{code}}-t sample_tag2{{/code}} to the command (see example below using {{code}}tag1{{/code}} and {{code}}tag2{{/code}} as tags).
++* In addition, you can also use attribute templates for a more enriched annotation of your files. Please note, that the corresponding attribute template file needs to be edited & saved prior to uploading. To get the blank template, see the **attribute-export** instructions above for more details. To attach a attribute JSON-file to your file upon uploading, use -a cli_Manifest1_template.json, where “cli_Manifest1_template.json" points to the location of the attributes JSON-file on your local machine.
++* Upon uploading, pilotcli will also validate the content of the attached attribute JSON-file. Whenever a template is invalid, including missing non-optional fields, non-existing choice in multiple choice attribute, exceeding length text field and so on, pilotcli will raise error to user and user must update the attribute template and upload again:
++
++
++
++
  ----
  -