Changes for page Working with HDC Project Files in the Command Line Interface
Last modified by Dennis Segebarth on 2024/10/02 18:38
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -252,16 +252,135 @@ 252 252 253 253 * **Options**: -p ~-~-project-code 254 254 * **Usage**: List all attributes from a specified Project. 255 +* **Prerequisite**: 256 + 257 +* User login is required, otherwise an error is returned: ‘The current login session is invalid. Please login to continue.’ 258 +* Requires the Project code, which can be retrieved via {{code}}pilotcli project list{{/code}}. 259 + 260 +{{code language="none"}} 261 +$ pilotcli file attribute-list --help 262 +Usage: pilotcli file attribute-list [OPTIONS] 263 + 264 + List attribute templates of a given Project. 265 + 266 +Options: 267 + -p, --project-code TEXT Project Code 268 + --help Show this message and exit. 269 +{{/code}} 270 + 271 +=== Examples === 272 + 273 +List attributes from a given Project by providing the Project Code at the prompt. In this example, “cli” is the corresponding Project Code: 274 + 275 +{{code language="none"}} 276 +$ pilotcli file attribute-list 277 +ProjectCode: cli 278 + 279 +Manifest1 280 +-------------------------------------------------------------------------- 281 +| Attribute Name | Type | Value | Optional | 282 +-------------------------------------------------------------------------- 283 +| attr1 | multiple_choice | a1,a2,a3,a4,a5 | False | 284 +-------------------------------------------------------------------------- 285 +| attr2 | text | None | False | 286 +-------------------------------------------------------------------------- 287 +| attr3 | multiple_choice | t1,t2,t3,t4,t5 | True | 288 +-------------------------------------------------------------------------- 289 + 290 +Manifest2 291 +-------------------------------------------------------------------------- 292 +| Attribute Name | Type | Value | Optional | 293 +-------------------------------------------------------------------------- 294 +| attr1 | multiple_choice | a1,a2,a3,a4 | True | 295 +-------------------------------------------------------------------------- 296 +| attr2 | text | None | False | 297 +-------------------------------------------------------------------------- 298 +| attr3 | multiple_choice | t1,t2,t3 | True | 299 +-------------------------------------------------------------------------- 300 +All Attributes fetched successfully. 301 +{{/code}} 302 + 303 +List attributes from given a Project and provide the Project Code “cli” as an option in the same line {{code}}-p cli{{/code}}: 304 + 305 +{{code language="none"}} 306 +$ pilotcli file attribute-list -p cli 307 + 308 +Manifest1 309 +-------------------------------------------------------------------------- 310 +| Attribute Name | Type | Value | Optional | 311 +-------------------------------------------------------------------------- 312 +| attr1 | multiple_choice | a1,a2,a3,a4,a5 | False | 313 +-------------------------------------------------------------------------- 314 +| attr2 | text | None | False | 315 +-------------------------------------------------------------------------- 316 +| attr3 | multiple_choice | t1,t2,t3,t4,t5 | True | 317 +-------------------------------------------------------------------------- 318 + 319 +Manifest2 320 +-------------------------------------------------------------------------- 321 +| Attribute Name | Type | Value | Optional | 322 +-------------------------------------------------------------------------- 323 +| attr1 | multiple_choice | a1,a2,a3,a4 | True | 324 +-------------------------------------------------------------------------- 325 +| attr2 | text | None | False | 326 +-------------------------------------------------------------------------- 327 +| attr3 | multiple_choice | t1,t2,t3 | True | 328 +-------------------------------------------------------------------------- 329 +All Attributes fetched successfully. 330 +{{/code}} 331 + 332 +== Command: **attribute-export** == 333 + 334 +* **Options**: -p ~-~-project-code, -n ~-~-attribute-name 335 +* **Usage**: Export an attribute template as JSON-file from a given Project 255 255 * ((( 256 256 **Prerequisite**: 257 257 258 -* User login is required, otherwise an error is returned: ‘The current login session is invalid. Please login to continue.’ 259 -* Requires the Project code, which can be retrieved via `pilotcli project list. 339 +* User login is required, otherwise an error is returned: "The current login session is invalid. Please login to continue." 340 +* Project must be accessible to the user, otherwise an error is returned: "Project Code not found in list. Please verify and try again." 341 +* Requires the Project code, which can be retrieved via pilotcli project list. 342 +* Requires the Attribute template name. If the attribute template name does not exist or is spelled incorrectly, an error is returned: "Attribute 'sample-template' not found in Project. Please verify and try again." 343 +* pilotcli must have the permission to write a file in the directory, otherwise an error is returned. 260 260 ))) 261 261 346 +{{code language="none"}} 347 +$ pilotcli file attribute-export --help 348 +Usage: pilotcli file attribute-export [OPTIONS] 262 262 350 + Export attribute template from a given Project. 263 263 352 +Options: 353 + -p, --project-code TEXT Project Code 354 + -n, --attribute-name TEXT Attribute Template Name 355 + --help Show this message and exit. 356 +{{/code}} 264 264 358 +=== Examples === 359 + 360 +Export an attribute template from a given Project. The user is prompted to provide the Project Code (“cli”) and the Attribute Template Name (“Manifest1”): 361 + 362 +{{code language="none"}} 363 +$ pilotcli file attribute-export 364 +ProjectCode: cli 365 +AttributeName: Manifest1 366 + 367 +Manifest1 368 +-------------------------------------------------------------------------- 369 +| Attribute Name | Type | Value | Optional | 370 +-------------------------------------------------------------------------- 371 +| attr1 | multiple_choice | a1,a2,a3,a4,a5 | False | 372 +-------------------------------------------------------------------------- 373 +| attr2 | text | None | False | 374 +-------------------------------------------------------------------------- 375 +| attr3 | multiple_choice | t1,t2,t3,t4,t5 | True | 376 +-------------------------------------------------------------------------- 377 +Template saved successfully: cli_Manifest1_template.json 378 +Attribute definition saved successfully: cli_Manifest1_definition.json 379 +{{/code}} 380 + 381 +Export an attribute template from a given Project using options to provide both the Project Code {{/code}}(-p cli){{/code}} and the Attribute Template Name (-n Manifest1), “cli” and “Manifest1” in this case, respectively: 382 + 383 + 265 265 ---- 266 266 267 267 - ... ... @@ -271,4 +271,5 @@ 271 271 272 272 Copyright © 2023 [[Indoc Research>>url:https://www.indocresearch.org/]]. 273 273 274 -HealthDataCloud is powered by Pilot technology, a product of [[Indoc Research>>url:https://www.indocresearch.org/]]. 393 +HealthDataCloud is powered by Pilot technology, a product of [[Indoc Research>>url:https://www.indocresearch.org/]].~{~{/code}} 394 +~)~)~)