Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions site/get-started/administrator/quickstart-administrator.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ listing:
contents:
- ../../training/administrator-fundamentals/administrator-fundamentals-register.qmd
- ../../guide/guides.qmd
includes:
quickstart: true
---

Set up the foundational units for your organization within the {{< var validmind.platform >}}, prepare your organization for users, then grant access to your first user.
Expand All @@ -23,13 +25,7 @@ Set up the foundational units for your organization within the {{< var validmind

## Set up your organization

First, let's set up the foundational units of your organization:

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under Workspace, select **Organization**.

3. Add business units and use cases as required by your organization.
First, let's set up the foundational units of your organization. In the left sidebar, click **{{< fa gear >}} Settings** to add business units and use cases:

::: {.panel-tabset}

Expand Down
4 changes: 2 additions & 2 deletions site/guide/attestation/_add-attestations.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
:::: {.content-visible unless-format="revealjs"}
1. In the left sidebar, click **{{< fa gear >}} Settings**.

1. Under Workspace, select **Attestation Templates**.
1. Under {{< fa shield >}} Governance, select **Attestation Templates**.

1. Click **{{< fa plus >}} Add Attestation Template**.

Expand All @@ -22,7 +22,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
:::: {.content-hidden unless-format="revealjs"}
a. In the left sidebar, click **{{< fa gear >}} Settings**.

a. Under Workspace, select **Attestation Templates**.
a. Under {{< fa shield >}} Governance, select **Attestation Templates**.

a. Click **{{< fa plus >}} Add Attestation Template**.

Expand Down
2 changes: 1 addition & 1 deletion site/guide/attestation/_configure-attestations.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To edit an existing attestation template:

1. In the left sidebar, click **{{< fa gear >}} Settings**.

1. Under Workspace, select **Attestation Templates** and then click an attestation template to edit.
1. Under {{< fa shield >}} Governance, select **Attestation Templates** and then click an attestation template to edit.

::: {.panel-tabset}

Expand Down
10 changes: 5 additions & 5 deletions site/guide/attestation/manage-attestations.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ For testing purposes only, you can trigger the attestation process:

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under Workspace, select **Attestation Templates** and then click the attestation template to test.
2. Under {{< fa shield >}} Governance, select **Attestation Templates** and then click the attestation template to test.

3. Under **Attestation Periods**, hover over an attestation period.

Expand All @@ -60,7 +60,7 @@ After starting the schedule, attestation participants are notified via My Inbox

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under Workspace, select **Attestation Templates** and then click the attestation template to edit.
2. Under {{< fa shield >}} Governance, select **Attestation Templates** and then click the attestation template to edit.

3. Under **Attestation Periods**, hover over an attestation period.

Expand All @@ -84,7 +84,7 @@ This action cannot be undone. The history of previous attestation periods is una

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under Workspace, select **Attestation Templates** and then click the attestation template to manage.
2. Under {{< fa shield >}} Governance, select **Attestation Templates** and then click the attestation template to manage.

3. Under **Attestation Periods**, hover over an attestation period.

Expand Down Expand Up @@ -180,7 +180,7 @@ To manually complete an attestation period:

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under Workspace, select **Attestation Templates** and then click the attestation template.
2. Under {{< fa shield >}} Governance, select **Attestation Templates** and then click the attestation template.

3. Under **Attestation Periods**, hover over an active attestation period.

Expand All @@ -200,7 +200,7 @@ You cannot delete an attestation template if it has any active attestation perio

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under Workspace, select **Attestation Templates**.
2. Under {{< fa shield >}} Governance, select **Attestation Templates**.

3. Locate the template to delete and hover over it.

Expand Down
27 changes: 20 additions & 7 deletions site/guide/configuration/_add-business-units.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,27 @@
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

:::: {.content-visible unless-format="revealjs"}
a. Click **{{< fa plus >}} Add New Business Unit** under Business Units.
:::: {.content-visible when-format="html" when-meta="includes.quickstart"}
1. Under {{< fa building >}} Organization, select **Organization**.

1. Click **{{< fa plus >}} Add Business Unit** under Business Units.

1. Enter in your **[business unit name]{.smallcaps}**.

1. Click **Add Business Unit** to save your changes.

After you save, confirm that the business unit was added as a new entry in alphabetical order.

::::

:::: {.content-visible unless-format="revealjs" unless-meta="includes.quickstart"}
a. Click **{{< fa plus >}} Add Business Unit** under Business Units.

a. Enter in your **[business unit name]{.smallcaps}**.

a. Click **{{< fa plus >}} Add Business Unit** to save your changes.
a. Click **Add Business Unit** to save your changes.

After you save, confirm that the business unit was added as a new entry in alphabetical order..
After you save, confirm that the business unit was added as a new entry in alphabetical order.

::::

Expand All @@ -18,13 +31,13 @@ a. Click **{{< fa plus >}} Add Business Unit** to save your changes.

a. In the left sidebar, click **{{< fa gear >}} Settings**.

a. Under Workspace, select **Organization**.
a. Under {{< fa building >}} Organization, select **Organization**.

a. Click **{{< fa plus >}} Add New Business Unit** under Business Units.
a. Click **{{< fa plus >}} Add Business Unit** under Business Units.

a. Enter in your **[business unit name]{.smallcaps}**.

a. Click **{{< fa plus >}} Add Business Unit** to save your changes.
a. Click **Add Business Unit** to save your changes.

After you save, confirm that the business unit was added as a new entry in alphabetical order.
::::
10 changes: 5 additions & 5 deletions site/guide/configuration/_add-groups.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,29 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
:::: {.content-visible unless-format="revealjs"}
1. In the left sidebar, click **{{< fa gear >}} Settings**.

1. Under User Permissions, select **Groups**.
1. Under {{< fa users >}} Users & Access, select **Groups**.

1. Next to All Groups, click **{{< fa plus >}} Create Group** to open the Create New Group menu.
1. Click **{{< fa plus >}} Create Group**.

1. Enter a **[group name]{.smallcaps}** and **[group description]{.smallcaps}** for the new group and click **Continue**.

1. Select users from the list to add them to the group.

1. Click **{{< fa check >}} Create Group** to save.
1. Click **Create Group** to save.

Confirm that the new group is created and appears in the list of available groups in alphabetical order.

::::


:::: {.content-hidden unless-format="revealjs"}
1. Next to All Groups, click **{{< fa plus >}} Create Group** to open the Create New Group menu.
1. Click **{{< fa plus >}} Create Group**.

1. Enter a **[group name]{.smallcaps}** and **[group description]{.smallcaps}** for the new group and click **Continue**.

1. Select users from the list to add them to the group.

1. Click **{{< fa check >}} Create Group** to save.
1. Click **Create Group** to save.

Confirm that the new group is created and appears in the list of available groups in alphabetical order.

Expand Down
16 changes: 8 additions & 8 deletions site/guide/configuration/_add-model-stakeholder-types.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,31 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

:::: {.content-visible unless-format="revealjs"}
1. In the left sidebar, click **{{< fa gear >}} Settings**.
1. In the left sidebar, click **{{< fa gear >}} Settings**.

1. Under Models, select **Model Stakeholder Types**.
1. Under {{< fa cube >}} Model Inventory, select **Model Stakeholder Types**.

1. Click **{{< fa plus >}} Add New Stakeholder Type**.
1. Click **{{< fa plus >}} Add Stakeholder Type**.

1. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the stakeholder type.^[Role names and stakeholder type names cannot be duplicated to reduce confusion.]

1. Once you click **{{< fa plus >}} Add Stakeholder Type**, you can:
1. Once you click **Add Stakeholder Type**, you can:

- Configure stakeholder type selection available upon model registration^[[Configure stakeholder types on registration](/guide/configuration/manage-model-stakeholder-types.qmd#configure-stakeholder-types-on-registration)]
- Manage the model inventory field^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)] permissions associated with that type
- Manage the model inventory field^[[Manage stakeholder type permissions](/guide/configuration/manage-model-stakeholder-types.qmd#manage-stakeholder-type-permissions)] permissions associated with that type

::::

:::: {.content-hidden unless-format="revealjs"}
a. In the left sidebar, click **{{< fa gear >}} Settings**.

a. Under Models, select **Model Stakeholder Types**.
a. Under {{< fa cube >}} Model Inventory, select **Model Stakeholder Types**.

a. Click **{{< fa plus >}} Add New Stakeholder Type**.
a. Click **{{< fa plus >}} Add Stakeholder Type**.

a. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the stakeholder type.

1. Once you click **{{< fa plus >}} Add Stakeholder Type**, you can:
1. Once you click **Add Stakeholder Type**, you can:

- Configure stakeholder type selection available upon model registration
- Manage the model inventory field permissions associated with that type
Expand Down
23 changes: 12 additions & 11 deletions site/guide/configuration/_add-remove-group-members.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,32 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
:::: {.content-visible unless-format="revealjs"}
1. In the left sidebar, click **{{< fa gear >}} Settings**.

1. Under User Permissions, select **Groups**.
1. Under {{< fa users >}} Users & Access, select **Groups**.

::: {.panel-tabset}

#### Add members

a. Click on the group you want to add members to.

a. Click **{{< fa plus >}} Add New Member**.
a. Click **{{< fa user-plus >}} Add Member**.

a. Select members by checking the boxes next to their names in the pop-up.
a. Select members by checking the boxes next to their names.

a. Click **{{< fa plus >}} Add to Group**.
a. Click **Add # User(s) Group**.

Confirm that the new member is added to the correct group.
Confirm that the new members are added to the correct group.

#### Remove members

a. Click on the group you want to remove members from.

a. Select members to be removed from the group by checking the boxes next to their names.

a. Click **{{< fa user-minus >}} Remove Member**.
a. Review the number of selected members to be removed, then click **{{< fa user-minus >}} Remove**.

a. Click **{{< fa user-minus >}} Remove # member(s)** to confirm removal of selected members from that group.

a. After you confirm, the user will be removed from that group.

:::

Expand All @@ -39,12 +40,12 @@ a. After you confirm, the user will be removed from that group.
:::: {.content-hidden unless-format="revealjs"}
1. Click on the group you want to add members to.

1. Click **{{< fa plus >}} Add New Member**.
1. Click **{{< fa user-plus >}} Add Member**.

1. Select members by checking the boxes next to their names in the pop-up.
1. Select members by checking the boxes next to their names.

1. Click **{{< fa plus >}} Add to Group**.
1. Click **Add # User(s) Group**

Confirm that the new member is added to the correct group.
Confirm that the new members are added to the correct group.

::::
24 changes: 19 additions & 5 deletions site/guide/configuration/_add-roles.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,40 @@
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

:::: {.content-visible unless-format="revealjs"}
:::: {.content-visible unless-format="revealjs" unless-meta="includes.quickstart"}
1. In the left sidebar, click **{{< fa gear >}} Settings**.

1. Under User Permissions, select **Roles**.
1. Under {{< fa users >}} Users & Access, select **Roles**.

1. Click **{{< fa plus >}} Add Role**.

1. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role.^[Role names and model stakeholder type names cannot be duplicated to reduce confusion.]

1. Once you click **{{< fa plus >}} Add Role**, you can proceed with managing the user permissions and users associated with that role.
1. Once you click **Add Role**, you can proceed with managing the user permissions and users associated with that role.
::::


:::: {.content-visible when-format="html" when-meta="includes.quickstart"}
1. In the left sidebar, click **{{< fa gear >}} Settings**.

1. Under {{< fa users >}} Users & Access, select **Roles**.

1. Click **{{< fa plus >}} Add Role**.

1. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role.^[Role names and model stakeholder type names cannot be duplicated to reduce confusion.]

1. Once you click **Add Role**, you can proceed with managing the user permissions associated with that role.

::::

:::: {.content-hidden unless-format="revealjs"}
a. In the left sidebar, click **{{< fa gear >}} Settings**.

a. Under User Permissions, select **Roles**.
a. Under {{< fa users >}} Users & Access, select **Roles**.

a. Click **{{< fa plus >}} Add Role**.

a. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role.

a. Once you click **{{< fa plus >}} Add Role**, you can proceed with managing the user permissions and users associated with that role.
a. Once you click **Add Role**, you can proceed with managing the user permissions associated with that role.
::::
34 changes: 21 additions & 13 deletions site/guide/configuration/_add-use-cases.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,19 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

1. In the left sidebar, click **{{< fa gear >}} Settings**.

1. Under Models, select **Model Inventory Fields**.
1. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**.

1. In the Default Fields group, click on the **Use Case** field to add use cases and use case groups.
1. In the Default Fields group, click on the **Use Case** field to add or remove use cases and use case groups:
::::


#### Add use case group

To add a grouping for use cases:

a. Type in your group title under **[options and groups]{.smallcaps}**.

a. Click **{{< fa chevron-down >}}** next to {{< fa plus >}} Add Option.
:::: {.content-visible when-format="html" when-meta="includes.quickstart"}
1. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**.

a. Select **{{< fa plus >}} Add Group** then click **{{< fa plus >}} Add Group** to insert the group.
1. In the Default Fields group, click on the **Use Case** field to add use cases and use case groups:

a. Click **Save Configuration** to save the inserted use case group.
::::

After you save, confirm that the use case group was added as a new entry at the bottom of the group list.

#### Add use case option

Expand All @@ -37,4 +31,18 @@ a. Click **{{< fa plus >}} Add Option** to add the use case to the list.

a. (Optional) Hover over your use case, then click and hold to drag and drop the use case to a group.

a. Click **Save Configuration** to save the inserted use case.
a. Click **Save Configuration** to save the inserted use case.

#### Add use case group

To add a grouping for use cases:

a. Type in your group title under **[options and groups]{.smallcaps}**.

a. Click **{{< fa chevron-down >}}** next to {{< fa plus >}} Add Option.

a. Select **{{< fa plus >}} Add Group** then click **{{< fa plus >}} Add Group** to insert the group.

a. Click **Save Configuration** to save the inserted use case group.

After you save, confirm that the use case group was added as a new entry at the bottom of the group list.
Loading