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

Summary

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

Details

Page properties

Content

...	...	@@ -584,12 +584,44 @@
584	584	Upload a file with tags and/or attributes.
585	585
586	586	* 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).
587		-* 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.
	587	+* 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 {{code}}-a cli_Manifest1_template.json{{/code}}, where “{{code}}cli_Manifest1_template.json{{/code}}" points to the location of the attributes JSON-file on your local machine.
588	588	* 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:
589	589
	590	+{{code language="none"}}
	591	+$ pilotcli file upload ./sample_folder/sample_file6 -p cli/admin -t tag1 -t tag2 -a cli_Manifest1_template.json
	592	+File attribute validation passed: True
	593	+Starting upload of: ./sample_folder/sample_file6
	594	+Pre-upload complete.
	595	+uploader: admin container_id: 18061 total_size: 1048576 total_chunks: 1 uniq_identifier: bc47ec2a-1a4e-4f71-a37a-7ce6473e415a-1627499273 resumable_relative_path admin/
	596	+
	597	+Upload job is finalizing, please wait...
	598	+Upload job complete.
	599	+Attribute attached
	600	+All files uploaded successfully.
	601	+{{/code}}
590	590
	603	+Upload a file with specified number of threads, using the {{code}}-td <thread_number>{{/code}} option.
591	591
	605	+* By default, the number of threads is 1. There will no UI difference when using threads. The maximal number of threads depends on your local machine and the recommend thread number is 3:
592	592
	607	+{{code language="none"}}
	608	+$ pilotcli file upload -p indoctestproject/admin/test20230306_3 /home/color/indoc/script/large_folder_test_data/gentoo_root_100M.img -td 3
	609	+Target folder does not exist. Would you like to create a new folder? [y/N]: y
	610	+Starting upload of: /home/color/indoc/script/large_folder_test_data/gentoo_root_100M.img
	611	+Pre-upload complete.
	612	+Uploading gentoo_root_100M.img , resumable_id: c68752372b42c85d, job_id: 56de3632-58df-445c-bcb9-bddfe6be5bf7: |██████████████████████████████ 100% 00:00
	613	+Upload Time: 79.77s for 1 files
	614	+All uploading jobs have finished.
	615	+{{/code}}
	616	+
	617	+(10) upload with customized manifest name
	618	+
	619	+When you upload a file using pilotcli, a JSON file with the details of your specific upload job will be created automatically and allows you to resume the upload at a later time, in case the process is aborted due to any reason. By default, this JSON file will be created as “manifest.json” in the current working directory (see //Command: **resume**// below for more details on how to resume the file upload). However, you can use the {{code}}--output-path{{/code}} option to specify the filepath and, thus, the filename of this JSON file:
	620	+
	621	+
	622	+
	623	+
	624	+
593	593	----
594	594
595	595	-