diff --git a/site/guide/validation/_add-edit-artifact-types.qmd b/site/guide/validation/_add-edit-artifact-types.qmd index 56ed90138..cb66fe3ca 100644 --- a/site/guide/validation/_add-edit-artifact-types.qmd +++ b/site/guide/validation/_add-edit-artifact-types.qmd @@ -15,11 +15,12 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 5. Click **Create** to create your new artifact type. + Every default artifact field except **Risk Area** starts out turned on for a new artifact type. To turn fields on or off, or to show or require them when creating artifacts of this type, configure them in **Artifact Fields**.[^add-fields-callout] + 6. Click on your newly created artifact type to edit its details and permissions. 7. Enter the artifact type's details: - - **Fields** — Select the default artifact fields that should appear on this type of artifact and click **Save Fields** to apply your changes.[^add-fields-callout] - **Record Fields Display**[^add-record-fields-config] — Select which upstream record fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] to display as read-only under the Inventory Record Information section on artifacts of this type and click **Save Record Fields Configuration** to apply your changes. - **Artifact Statuses** — Configure the statuses available to this artifact type.^[[Manage artifact type statuses](#manage-artifact-type-statuses)] @@ -41,7 +42,6 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> - **Name**, **Description**, and **Slug** — Edit the artifact type's details and click **Save Details** to apply your changes. You can rename any artifact type, including the default ones.[^edit-details] - The name is shown everywhere the artifact type appears, such as the sidebar, artifact lists and filters, and workflows. Dashboard charts filtered to the artifact type by name are updated to the new name. Names must be unique within your organization and 255 characters or fewer. - The slug identifies the artifact type in permissions and in links to its settings. Slugs must be unique within your organization and use only lowercase letters, numbers, and dashes. - - **Fields** — Select the default artifact fields that should appear on this type of artifact and click **Save Fields** to apply your changes.[^edit-fields-callout] - **Record Fields Display**[^edit-record-fields-config] — Select which upstream record fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] to display as read-only under the Inventory Record Information section on artifacts of this type and click **Save Record Fields Configuration** to apply your changes. - **Artifact Statuses** — Configure the statuses available to this artifact type.^[[Manage artifact type statuses](#manage-artifact-type-statuses)] @@ -54,12 +54,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -[^add-fields-callout]: - - ::: {.callout title="Only default fields are available to be selected in this view."} - To further customize fields displayed on artifact types, refer to: [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd) - - ::: +[^add-fields-callout]: [Configure default artifact fields](/guide/validation/manage-artifact-fields.qmd#configure-default-artifact-fields) [^add-record-fields-config]: @@ -78,13 +73,6 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ::: -[^edit-fields-callout]: - - ::: {.callout title="Only default fields are available to be selected in this view."} - To further customize fields displayed on artifact types, refer to: [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd) - - ::: - [^edit-record-fields-config]: - Drag-and-drop fields to reorder them. @@ -109,10 +97,9 @@ c. Click **Create** to create your new artifact type. d. Click on your newly created artifact type to edit its details and permissions. - Most changes are saved automatically. + Every default artifact field except **Risk Area** starts out turned on. Configure them per artifact type in **Artifact Fields**. - - For **Fields** configuration, click **Save Fields** to apply changes. - - For **Record Fields Display** configuration, click **Save Record Fields Configuration** to apply changes. + Most changes are saved automatically. For **Record Fields Display** configuration, click **Save Record Fields Configuration** to apply changes. #### Edit artifact types @@ -123,7 +110,6 @@ b. Make your desired changes to the artifact type's details and permissions. Most changes are saved automatically. - For **Name**, **Description**, and **Slug**, click **Save Details** to apply changes. - - For **Fields** configuration, click **Save Fields** to apply changes. - For **Record Fields Display** configuration, click **Save Record Fields Configuration** to apply changes. :::: diff --git a/site/guide/validation/manage-artifact-fields.qmd b/site/guide/validation/manage-artifact-fields.qmd index 8449ffbcb..5a1b55090 100644 --- a/site/guide/validation/manage-artifact-fields.qmd +++ b/site/guide/validation/manage-artifact-fields.qmd @@ -46,7 +46,7 @@ includes: - **Artifact Types** lists the active artifact types the field is turned on for.[^9] - **Required** lists the artifact types that require the field when creating an artifact. - **Title** and **Description** apply to all artifact types. Default fields can't be edited or deleted from this page. + **Title** and **Description** apply to all artifact types and are always required. You can configure the other default fields for each artifact type,[^10] but default fields can't be renamed or deleted. 3. Narrow down existing artifacts fields available to your artifacts by searching or filtering for results: @@ -81,6 +81,40 @@ b. Click **Apply Filters** to narrow down your results by your configured criter For example, if you first search by keyword for `Regression` under **Title** without clearing that search, any additional filters applied will only apply to the results returned by that initial search. ::: +## Configure default artifact fields + +For each default field except **Title** and **Description**, choose which artifact types use it and how it behaves when artifacts are created: + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa expand >}} Artifacts, select **Artifact Fields**. + +3. In the **Default Fields** group, hover over the field you want to configure. + +4. When the **{{< fa ellipsis-vertical >}}** menu appears under the Actions column, click on it and select **{{< fa sliders >}} Configure**. + +5. For each active artifact type, set: + + Enabled + : The field appears on artifacts of this type: on the artifact details page, in artifact filters, and in workflow steps. Turning a field off also turns off the two options below. + + Show on creation + : The field appears when creating an artifact of this type. When off, the field can still be filled in on the artifact details page after the artifact is created. + + Require on creation + : An artifact of this type can't be created without a value for the field, whether in the {{< var validmind.platform >}} or through the {{< var vm.product >}} API. + +6. Click **Save Configuration** to apply your changes. + + If you turn a field off for an artifact type that a workflow uses the field on, the workflows affected are listed first. Click **Yes, Disable** followed by the field name to save anyway. + +::: {.callout title="Some default fields have fixed rules."} +- **Risk Area** is always required when it is shown on creation. +- **Status**, **Attachments**, and **Proposed Remediation Plan** can only be turned on or off. New artifacts start in the default status, and attachments and remediation plans are added on the artifact details page after creation. +- Turning a field off hides it but keeps the values already saved on existing artifacts. Those values remain available through the {{< var vm.product >}} API and data exports. + +::: + ## Add or edit artifact fields @@ -156,3 +190,5 @@ Deleting an artifact field will remove it from all artifacts using that field, e [^8]: [Add or edit artifact fields](#add-or-edit-artifact-fields) [^9]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) + +[^10]: [Configure default artifact fields](#configure-default-artifact-fields)