Skip to content

Commit aa5ca3a

Browse files
ctaUX.md
1 parent 131c3ce commit aa5ca3a

File tree

1 file changed

+31
-55
lines changed
  • docs/embedded/concepts/admin-exp/consuming-tenant-admin

1 file changed

+31
-55
lines changed

docs/embedded/concepts/admin-exp/consuming-tenant-admin/ctaUX.md

Lines changed: 31 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,19 @@
22

33
The organizations that use the SharePoint Embedded applications on their Microsoft 365 (M365) tenants are the consuming tenants and the persona that is responsible for managing these applications on their Microsoft 365 tenancy is the consuming tenant administrator (CTA). Consuming tenant administrators can manage containers through a graphical user interface (GUI) using the [SharePoint Administrator Center](https://go.microsoft.com/fwlink/?linkid=2185219) (SPAC).
44

5-
To manage SharePoint Embedded containers, tenant administrators need to be assigned the Microsoft 365 SharePoint Embedded Administrator role. Global Administrators in Microsoft 365 have all the permissions of the SharePoint Embedded Administrator role. A SharePoint Administrator can assign themselves the SharePoint Embedded Administrator role to act as a Consuming Tenant Admin for SharePoint Embedded. This role is available in both Microsoft Entra and the Microsoft 365 Admin Center.
5+
To manage SharePoint Embedded containers, CTA need to be assigned the Microsoft 365 SharePoint Embedded Administrator role. Global Administrators in Microsoft 365 have all the permissions of the SharePoint Embedded Administrator role. A SharePoint Administrator can assign themselves the SharePoint Embedded Administrator role to act as a CTA for SharePoint Embedded. This role is available in both Microsoft Entra and the Microsoft 365 Admin Center.
66
For information on SharePoint Embedded admin role, [see](https://github.com/cindylay/sp-dev-docs/blob/update-ga/docs/embedded/concepts/admin-exp/adminrole.md).
77

88
The following actions are supported in SPAC:
99

1010
1. View active containers in the tenant
1111
2. View deleted containers in the tenant
1212
3. View detailed information of a container
13-
4. Soft delete a container
13+
4. Delete a container
1414
5. Restore a deleted container
15-
6. Purge a deleted container
16-
17-
Global admin will also see "Active Containers" and "Deleted Containers" page along with Site administration pages when they log in to SharePoint Admin Center.
15+
6. Permanently deleted a container
1816

17+
Global Admin will also see "Active Containers" and "Deleted Containers" page along with Site administration pages when they log in to SharePoint Admin Center.
1918

2019
<img width="1243" alt="image" src="https://github.com/cindylay/sp-dev-docs/assets/132292644/44a7749e-ed3c-41ed-ac18-e4b35730e544">
2120

@@ -35,41 +34,38 @@ The Active Containers page displays all the active containers within the tenant,
3534
6. **Sensitivity label :** Name of the label assigned to the container
3635
7. **Created on :** Date and time when the container was created
3736

38-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/0ff42ea0-832b-4618-8da1-ed30365786fd)
37+
<img width="1246" alt="image" src="https://github.com/cindylay/sp-dev-docs/assets/132292644/0531ec13-8f21-4f9e-8c9d-86158dfd0438">
3938

4039

4140
### View details of a containers
4241
The detailed container view provides a deeper dive into container-specific metadata, organized under two tabs:
4342

44-
1. **General:** This panel displays all the general metadata about a container, such as its purpose, usage, and configuration settings.
45-
46-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/cd85c8dc-31be-46ee-9e8c-5e1318496359)
43+
1. **General:** This panel displays all the general metadata about a container, usage, and configuration settings.
44+
45+
<img width="1243" alt="image" src="https://github.com/cindylay/sp-dev-docs/assets/132292644/d17c14c3-c253-4b62-8d18-4319688b2223">
4746

4847
2. **Membership:** This panel shows the user permissions for different users associated with the container.
4948

5049
> [!IMPORTANT]
5150
> The SharePoint Embedded platform supports four distinct [roles](docs/embedded/concepts/app-concepts/sharing-and-perm.md): Owner, Manager, Writer, and Reader. The SharePoint Embedded application on your tenant may not utilize all four roles and might refer to these roles using different names.
5251
>
53-
> Admins should verify the mapping of the roles provided by the platform to those used in the application.
5452
5553
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/f4c8c143-01d3-473f-842d-733a5eb6b4d5)
5654

57-
58-
## Deleted Containers
59-
The deleted containers page lists down all the soft deleted containers present in the admin’s tenant. It lists the following metadata:
55+
## Deleted Containers
56+
The deleted containers page lists all containers in the tenants deleted container collection. It lists the following metadata:
6057
1. Container name
6158
2. Application name
6259
3. Publisher name
6360
4. Storage
6461
5. Owners
6562
6. Sensitivity label
6663
7. Created on
67-
8. **Deleted on :**Date and time when the container was soft deleted.
64+
8. **Deleted on :**Date and time when the container was deleted.
6865

69-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/614c9083-4d3f-40ec-9e77-dcb9ab31fdea)
66+
<img width="1247" alt="image" src="https://github.com/cindylay/sp-dev-docs/assets/132292644/54a287b9-232e-4027-af96-a9389b6f4ac4">
7067

71-
72-
## Soft delete a container
68+
## Delete a container
7369

7470
> [!Warning]
7571
>
@@ -81,70 +77,50 @@ Deleting a container can have implications on the functionality of a SharePoint
8177

8278
2. **Broken Links:** If the SharePoint Embedded application contains links or references to the deleted container, those links become broken, leading to errors or malfunctioning features within the app.
8379

84-
3. **Permissions Issues:** Deleting a container can affect permissions settings. If the SharePoint Embedded app relies on specific permissions granted to the deleted container, it might encounter permission issues and fail to function properly.
85-
Therefore, it's essential to carefully consider the consequences of deleting a container and ensure that appropriate measures are taken to mitigate any potential issues.
86-
87-
A container can be soft deleted from the Active containers page for any business reason by the CTA. By default, the delete button is deactivated. On selecting a container, the delete button is activated. The CTA can then select the delete button.
80+
A container can be deleted from the Active containers page for any business reason by the CTA. By default, the delete button is deactivated. On selecting a container, the delete button is activated. The CTA can then select the delete button.
8881

89-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/0a649c5e-a39d-4822-b203-0dbb7f97b1ee)
82+
<img width="1243" alt="image" src="https://github.com/cindylay/sp-dev-docs/assets/132292644/1fed0fb2-4e95-4a51-a379-91223520ec9b">
9083

84+
This opens a side panel that warns the user about the effect on the associated SPE application due to the deletion of a container as well as inform the user about the restoration policy. The CTA can at this stage either cancel the panel and go back to the active containers page or proceed further with the deleting by clicking on “Delete container”.
9185

92-
This opens a side panel that warns the user about the effect on the associated SPE application due to the deletion of a container as well as inform the user about the restoration policy. The CTA can at this stage either cancel the panel and go back to the active containers page or proceed further with the deleting by clicking on “Delete container”.
93-
94-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/5f4d0ad0-8ca8-4a78-8b33-a04bc12b9d7b)
86+
<img width="1280" alt="image" src="https://github.com/cindylay/sp-dev-docs/assets/132292644/9d770bb3-e389-4a70-8db2-3ff85b864595">
9587

9688

97-
The selected container is successfully soft deleted and moved into the deleted containers page.
98-
99-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/175467e8-1154-40f4-bf3b-ee14718d81ae)
89+
The selected container is successfully deleted and moved into the deleted containers page.
90+
<img width="1277" alt="image" src="https://github.com/cindylay/sp-dev-docs/assets/132292644/69f0b5a3-05e0-4855-968c-6c020edfa13f">
10091

101-
**Any soft deleted container is retained for 93 days post which it is permanently deleted**
92+
**Deleted containers are permanently purged after 93 days unless there is a retention policy applied to the containers**
10293

10394
## Restore a container
104-
A soft-deleted container can be restored on the Deleted containers page by selecting the container to be restored. This activates the restore button which is by default deactivated.
105-
106-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/87b3480b-d315-4898-ae09-f03939fb901c)
95+
A container in the deleted container collection can be restored on the Deleted containers page by selecting the corresponding containers by selecting the "Restore" link
10796

108-
The CTA can then select Restore
97+
![image](https://github.com/cindylay/sp-dev-docs/assets/132292644/3ce195df-13b3-4152-ad36-6c1ddf253f35)
10998

110-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/96bd77d7-189d-425a-a638-61b95484b583)
11199

112-
The restoring of the container happens in the background and the status of the same is displayed on the top right corner of the page.
100+
Restoration of the container happens in the background and the status of the same is displayed on the top right corner of the page. Upon successful restoration, the container will be available in the Active Containers page.
113101

114-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/1220473d-4d30-460e-a43f-f20b068483fc)
102+
<img width="1275" alt="image" src="https://github.com/cindylay/sp-dev-docs/assets/132292644/2a2a3a2a-1b0c-4791-b24d-f89c3b34afd4">
115103

116-
117-
On successfully restoring, “Container restored” message is shown on the top right corner of the page.
118-
119-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/b58d3e8f-b79d-406b-9b7b-c862dd58776b)
120-
121-
122-
## Hard delete (purge) a container
104+
## Permanently delete a container
123105

124106
> [!Warning]
125107
>
126108
>Deleting a container may cause unexpected issues for the SharePoint Embedded application it belongs to and may interrupt the application's usage. This action should only be performed by admins when absolutely necessary.
127109
128-
The CTA can permanently delete (purge) a soft-deleted container if they decide to.
110+
The CTA can permanently delete a deleted container from the deleted container collection if they decide to.
129111

130112
The CTA selects the container to be permanently deleted. The “Permanently delete” button is enabled.
131113

132-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/9d615997-ac76-41b1-b414-fbb5dfe3f6b0)
114+
<img width="1277" alt="image" src="https://github.com/cindylay/sp-dev-docs/assets/132292644/9ced70e2-0da8-4b08-8c8f-becaccf292ee">
133115

134-
On clicking the button, a pop-up appears warning the CTA on the action they are performing. If absolutely sure, the CTA can proceed and click on “Delete”. Else the CTA can cancel the action.
116+
Upon clicking the button, a pop-up appears warning the CTA on the action they are performing. If absolutely sure, the CTA can proceed and click on “Delete”. Otherwise the CTA can cancel the action.
135117

136-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/0f165644-be3c-4538-944d-e2d5b15cca5d)
118+
<img width="1277" alt="image" src="https://github.com/cindylay/sp-dev-docs/assets/132292644/36b55434-264a-4891-abc7-087b11920729">
137119

138-
139-
On clicking Delete, the container is permanently deleted in the backend and the status of the same appears in the top-right corner of the page.
140-
141-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/bd53df0c-dfd9-4316-8700-b3b84dd125e1)
142-
143-
On successful deletion, the container is permanently deleted.
120+
Upon clicking Delete, the container is permanently deleted and the status of the same appears in the top-right corner of the page.Upon successful deletion, the container is permanently removed from the deleted container collection and cannot be restored.
144121

145-
![image](https://github.com/cindylay/sp-dev-docs/assets/136049061/4cedfce6-1b41-4525-a78d-c42f6eabdaf5)
122+
<img width="1279" alt="image" src="https://github.com/cindylay/sp-dev-docs/assets/132292644/d5ef9ceb-d1c0-4f74-b39d-77c21fc3079d">
146123

147-
`
148124
## Coming Soon
149125
1. Sort containers by created date and storage
150126
2. Filter containers by created date, application name and publisher name

0 commit comments

Comments
 (0)