Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the security overview docs #8958

Open
wants to merge 3 commits into
base: development
Choose a base branch
from
Open
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
54 changes: 49 additions & 5 deletions content/en/docs/refguide/modeling/security/security-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This feature is currently in beta. For more information, see [Beta and Experimen

## Introduction

The **Security Overview** page provides you with an overview of your app's security. This overview can be used to review the security of your app.
The **Security Overview** page provides you with an overview of your app's security. This overview can be used to review the security of your app. You can export this information to an Excel file. See the [Export To Excel](#export-excel) section below for more information.

## Viewing the Security Overview

Expand All @@ -27,9 +27,9 @@ The **Security Overview** summarizes the app's security for a selected user role
The **Security Overview** page has the following tabs:

* [Entity access](#entity-access)
* **Page access**
* **Microflow access**
* **Nanoflow access**
* [Page access](#page-access)
* [Microflow access](#microflow-access)
* [Nanoflow access](#nanoflow-access)

{{% alert color="info" %}}
In the beta release of the **Security Overview** page, only the **Entity access** tab is available. The other tabs will be available in future versions of Studio Pro.
Expand All @@ -46,7 +46,51 @@ Multiple columns are shown for entities with XPath constraints. Access rules wit

When the selected user role has no access to an attribute or an association, it is not shown in the table. If the selected user role has no access to an entity at all, the entity is not shown in the **Security Overview**.

### Page Access {#page-access}

The **Page Access** tab lists the names of pages within the selected module that are visible to the selected user role.

{{< figure src="/attachments/refguide/modeling/security/app-security/user-roles/page-security-overview.png" class="no-border" >}}

### Microflow Access {#microflow-access}

The **Microflow Access** tab lists the names of microflows within the selected module that can be executed by the selected user role.

{{< figure src="/attachments/refguide/modeling/security/app-security/user-roles/microflow-security-overview.png" class="no-border" >}}

### Nanoflow Access {#nanoflow-access}

The **Nanoflow Access** tab lists the names of nanoflows within the selected module that can be executed by the selected user role.

{{< figure src="/attachments/refguide/modeling/security/app-security/user-roles/nanoflow-security-overview.png" class="no-border" >}}

## Export To Excel {#export-excel}

To export the Security Overview, click the Export to Excel button. This generates an Excel file in the selected directory, which contains the following three sheets:

1. Entity Access: This sheet contains the entity access rules data, including:
1. User Role
2. Module: The module containing the entity.
3. Entity: The name of the entity.
4. Member: The attribute or association name.
5. Kind: Specifies whether the member is an association or an attribute.
6. Type: The type of the member.
7. XPath: The XPath constraint.
8. XPath Caption: The XPath constraint caption, when set.
9. Access: The access level (None, Read or ReadWrite).

2. Document Access: This sheet includes the accessible pages, microflows and nanoflows, including:
1. Document type: The type of the accessible document (Page, Microflow, Nanoflow).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if we should document that this (and some other) fields are translated and will be different based on your SP language.

Copy link
Contributor Author

@EnasAbdelrazek EnasAbdelrazek Jan 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, But that applies for everything in docs :)

2. User Role
3. Module: The module containing the the page, nanoflow, or microflow.
4. Document: The name of the page, nanoflow, or microflow.

3. Module Roles: This sheet provides the mappings between user roles and module roles, including:
1. User Role
2. Module
3. Module Role

## Read More

* [User Roles](/refguide/user-roles/)
* [Access Rules](/refguide/access-rules/).
* [Access Rules](/refguide/access-rules/)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.