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.2 to 1.1 From 1.4 to 1.3

From version 1.3

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

Change comment: (Autosaved)

To version 1.2

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

Change comment: (Autosaved)

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -268,119 +268,10 @@
    --help                   Show this message and exit.
  {{/code}}
--=== Examples ===
--List attributes from a given Project by providing the Project Code at the prompt. In this example, “cli” is the corresponding Project Code:
--{{code language="none"}}
--$ pilotcli file attribute-list
--ProjectCode: cli
--Manifest1
----------------------------------------------------------------------------
--|    Attribute Name    |       Type      |        Value         | Optional |
----------------------------------------------------------------------------
--|        attr1         | multiple_choice |    a1,a2,a3,a4,a5    |  False   |
----------------------------------------------------------------------------
--|        attr2         |       text      |         None         |  False   |
----------------------------------------------------------------------------
--|        attr3         | multiple_choice |    t1,t2,t3,t4,t5    |   True   |
----------------------------------------------------------------------------
--Manifest2
----------------------------------------------------------------------------
--|    Attribute Name    |       Type      |        Value         | Optional |
----------------------------------------------------------------------------
--|        attr1         | multiple_choice |     a1,a2,a3,a4      |   True   |
----------------------------------------------------------------------------
--|        attr2         |       text      |         None         |  False   |
----------------------------------------------------------------------------
--|        attr3         | multiple_choice |       t1,t2,t3       |   True   |
----------------------------------------------------------------------------
--All Attributes fetched successfully.
--{{/code}}
--
--List attributes from given a Project and provide the Project Code “cli” as an option in the same line {{code}}-p cli{{/code}}:
--
--{{code language="none"}}
--$ pilotcli file attribute-list -p cli
--
--Manifest1
----------------------------------------------------------------------------
--|    Attribute Name    |       Type      |        Value         | Optional |
----------------------------------------------------------------------------
--|        attr1         | multiple_choice |    a1,a2,a3,a4,a5    |  False   |
----------------------------------------------------------------------------
--|        attr2         |       text      |         None         |  False   |
----------------------------------------------------------------------------
--|        attr3         | multiple_choice |    t1,t2,t3,t4,t5    |   True   |
----------------------------------------------------------------------------
--
--Manifest2
----------------------------------------------------------------------------
--|    Attribute Name    |       Type      |        Value         | Optional |
----------------------------------------------------------------------------
--|        attr1         | multiple_choice |     a1,a2,a3,a4      |   True   |
----------------------------------------------------------------------------
--|        attr2         |       text      |         None         |  False   |
----------------------------------------------------------------------------
--|        attr3         | multiple_choice |       t1,t2,t3       |   True   |
----------------------------------------------------------------------------
--All Attributes fetched successfully.
--{{/code}}
--
--== Command: **attribute-export** ==
--
--* **Options**: -p ~-~-project-code, -n ~-~-attribute-name
--* **Usage**: Export an attribute template as JSON-file from a given Project
--* (((
--**Prerequisite**:
--
--* User login is required, otherwise an error is returned: "The current login session is invalid. Please login to continue."
--* Project must be accessible to the user, otherwise an error is returned: "Project Code not found in list. Please verify and try again."
--* Requires the Project code, which can be retrieved via pilotcli project list.
--* 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."
--* pilotcli must have the permission to write a file in the directory, otherwise an error is returned.
--)))
--
--{{code language="none"}}
--$ pilotcli file attribute-export --help
--Usage: pilotcli file attribute-export [OPTIONS]
--
--  Export attribute template from a given Project.
--
--Options:
--  -p, --project-code TEXT    Project Code
--  -n, --attribute-name TEXT  Attribute Template Name
--  --help                     Show this message and exit.
--{{/code}}
--
--=== Examples ===
--
--Export an attribute template from a given Project. The user is prompted to provide the Project Code (“cli”) and the Attribute Template Name (“Manifest1”):
--
--{{code language="none"}}
--$ pilotcli file attribute-export
--ProjectCode: cli
--AttributeName: Manifest1
--
--Manifest1
----------------------------------------------------------------------------
--|    Attribute Name    |       Type      |        Value         | Optional |
----------------------------------------------------------------------------
--|        attr1         | multiple_choice |    a1,a2,a3,a4,a5    |  False   |
----------------------------------------------------------------------------
--|        attr2         |       text      |         None         |  False   |
----------------------------------------------------------------------------
--|        attr3         | multiple_choice |    t1,t2,t3,t4,t5    |   True   |
----------------------------------------------------------------------------
--Template saved successfully: cli_Manifest1_template.json
--Attribute definition saved successfully: cli_Manifest1_definition.json
--{{/code}}
--
--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:
--
--
  ----
  -