Skip to content

Commit b86ff42

Browse files
Live publish for 30 May 2024.
2 parents 9b64e26 + 492f3c7 commit b86ff42

11 files changed

+368
-0
lines changed

powerapps-docs/maker/TOC.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2179,6 +2179,12 @@
21792179
href: "./data-platform/powerapps-checker/rules/web/use-relative-uri.md"
21802180
- name: "use-utility-dialogs"
21812181
href: "./data-platform/powerapps-checker/rules/web/use-utility-dialogs.md"
2182+
- name: Work with catalogs (preview)
2183+
items:
2184+
- name: Catalog overview
2185+
href: ./data-platform/catalog-overview.md
2186+
- name: View, submit, and install catalog items
2187+
href: ./data-platform/submit-acquire-from-catalog.md
21822188
- name: Work with dataflows
21832189
href: ./data-platform/self-service-data-prep-with-dataflows.md
21842190
items:
Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
---
2+
title: "Catalog in Power Platform"
3+
description: "Use the catalog in Power Platform to managed shared components and templates so that administrators, application makers, and developers within an organization can reuse each other's work."
4+
author: derekkwanpm
5+
ms.author: derekkwan
6+
ms.subservice:
7+
ms.date: 05/15/2024
8+
ms.reviewer: matp
9+
ms.topic: overview
10+
contributors:
11+
- JimDaly
12+
- ChrisGarty
13+
---
14+
# Catalog in Power Platform (preview)
15+
16+
[!INCLUDE [cc-beta-prerelease-disclaimer](../../includes/cc-beta-prerelease-disclaimer.md)]
17+
18+
Building from scratch every time by recreating branding, layouts, links, complex connectors and flows, and more is painful and error-prone. Organizations where developers and makers build and share customized and reusable components and templates get more value from Power Platform. Successful organizations adopt a *fusion teams* model where pro-developers, makers, and admins all work together to deliver the best solutions for their users, and derive the highest value possible from Power Platform.
19+
20+
> [!IMPORTANT]
21+
>
22+
> - This is a preview feature.
23+
> - [!INCLUDE [cc-preview-features-definition](../../includes/cc-preview-features-definition.md)]
24+
> - The catalog needs to be set up by an admin before you can use it, including permissions. More information [Administer the catalog](/power-platform/admin/administer-catalog#set-up-the-catalog).
25+
> - The catalog only works with Microsoft Dataverse environments. Environments without Dataverse aren't supported at this time.
26+
> - While not required for preview, when this feature is generally available, it'll require the use of Managed Environment capabilities. More information: [Managed Environments overview](/power-platform/admin/managed-environment-overview)
27+
28+
In any organization, there might be many components and templates distributed among many environments. The catalog in Power Platform enables developers and makers to:
29+
30+
- Crowd-source and find templates and components within their organization easily
31+
- Find and install the latest and authoritative version of a component
32+
- Get started with templates and components that provide immediate value
33+
34+
*Components* include things like:
35+
36+
- AI prompts
37+
- Copilot app templates
38+
- AI plugins
39+
- Power Platform dataflows
40+
- Custom connectors
41+
- Power Apps component framework controls
42+
- Power Automate flows
43+
- Canvas apps
44+
- Model-driven apps
45+
46+
*Templates* are items that represent an advanced starting point for components. Templates connect to their enterprise systems and resources and utilize an organization's themes.
47+
48+
## Terminology
49+
50+
These terms are important to understand when using the catalog:
51+
52+
|Term|Description|
53+
|---------|---------|
54+
|**Catalog Item**|The unit of interaction with the catalog is called an item. <br />- An item is what is being submitted to or installed from the catalog. <br /> - Typically, an item is a Dataverse solution or package deployer package. An item can contain a fully built application, a template for a Power App or flow, or a Power Platform code-first component such as a custom connector or Power Apps component framework (PCF) control. |
55+
|**Catalog Publisher**|The owning entity of the application. For example, the publisher can be the human resources IT team or another line of business team.<br /> - A group of people in an organization that are responsible for managing its lifecycle. <br /> - Support and engineering contacts can be provided.<br /> - Note that the catalog publisher is different from the solution publisher.|
56+
|**Submission** |The act of sharing an item involves submitting it to the catalog. This act creates a *submission request* in the system.|
57+
|**Submission Request**|The result of a submission. This request can be approved or declined. When auto approval is configured for the catalog, no approval is required.|
58+
|**Discovery**|Act of finding items within a catalog by authorized users.|
59+
|**Acquisition**|Act of installing the item to a target environment by a developer.|
60+
61+
## Catalog basics
62+
63+
The catalog needs to be set up by an admin before you can use it, including privileges. More information: [Administer the catalog](/power-platform/admin/administer-catalog#set-up-the-catalog).
64+
65+
You might choose to have multiple catalogs across environments for different regions, departments, or any group. Most organizations only need one catalog. A catalog admin can set up new catalogs in the [Power Platform admin center](https://admin.powerplatform.microsoft.com).
66+
67+
You can submit unmanaged solutions to the catalog for other makers to install and use for themselves, as one of these two catalog item types:
68+
69+
- A **template**: A copy of your unmanaged solution that other makers can edit however they choose. Updates to the original unmanaged solution won't update templates, as templates are no longer "connected" to the solution it came from. If you want other makers to have the ability to change the catalog components as they see fit, use a template.
70+
71+
> [!NOTE]
72+
> Currently, certain components aren't supported for use as templates.
73+
74+
- A **managed item**: Managed items can be updated with more versions as the original solution is updated, but are generally restricted from editing. If you want makers to use your solution *as is* and you also want to keep copies updated with your changes in the future, use a managed item. Managed items are useful for a variety of scenarios for makers:
75+
76+
- Use the assets of the managed item as is and make no changes.
77+
- Build custom functionality on top of the assets in the managed item without changing the original components.
78+
- Use the assets to assist with building your own solutions. For example, PCF components, custom connectors, and so on.
79+
80+
Admins can administer catalogs, manage access and security, approve catalog items, and more in the [Catalog Manager](/power-platform/admin/administer-catalog), which is the dedicated workspace for admins of the catalog. The catalog itself is designed for makers of any level of experience to publish, discover, and acquire useful catalog items for themselves.
81+
82+
## Discovery
83+
84+
The catalog area is available in Power Apps and Power Automate. On the catalog page are tiles representing all catalog items available to your organization. This includes items published by your organization, approved partners who have access to your environments, as well as many published by Microsoft, such as AI prompts, Copilot app templates, dataflow templates, enterprise templates, PCF controls, plug-ins, and more.
85+
86+
:::image type="content" source="media/catalog_gallery.png" lightbox="media/catalog_gallery.png" alt-text="The catalog gallery":::
87+
88+
On the page itself are the following controls:
89+
90+
- Search box (searches the titles of available catalog items)
91+
- Filters (filters for publisher, type, category, and more)
92+
- Catalog selector (some organizations might choose to create multiple catalogs for regions or departments). Users can have access to one or more catalogs.
93+
94+
The list of Microsoft published catalog items that will be available in your catalog out of the box are:
95+
96+
- AI Prompts
97+
- Copilot app templates
98+
- Enterprise templates
99+
- Power Platform dataflows
100+
- PCF controls
101+
- Plug-ins
102+
- Retail cloud templates
103+
- Copilot agents
104+
105+
## My Activity
106+
107+
Linked in the banner of the catalog page is the **My Activity** page. This shows useful info on items you have submitted and acquired, including approval status.
108+
109+
:::image type="content" source="media/myactivity_catalog.png" lightbox="media/myactivity_catalog.png" alt-text="The catalog My Activity page":::
110+
111+
Filters on top of the page allow you to look at different date ranges, types of catalog items, and across different catalogs (if you have multiple catalogs set up in your tenant).
112+
113+
- Metrics on this page:
114+
115+
- **Total items submitted**: Sum of all items you submitted.
116+
- **Items approved**: Sum of all items you submitted that were approved by your admin.
117+
- **Items awaiting approval**: Sum of all items you submitted that your admin has not responded to yet.
118+
- **Items acquired**: Sum of all items you acquired from the catalog.
119+
120+
- Catalog items acquired table:
121+
122+
- **Item ID**: Unique identifier for the acquired item.
123+
- **Item name**: Display name for the acquired item.
124+
- **Deployment type**: Whether item is a template or managed.
125+
- **Date acquired**: Date item was last acquired.
126+
- **Status**: Current status of the acquired item, such as completed or failed.
127+
- **Message**: Status message, can explain why an item failed.
128+
129+
- Catalog items submitted table:
130+
131+
- **Item ID**: Unique identifier for the submitted item.
132+
- **Item name**: Display name for the submitted item.
133+
- **Deployment type**: Whether item is a template or managed.
134+
- **Date submitted**: Date item was last submitted.
135+
- **Status**: Current status of the submitted item, such as approved, rejected, or pending approval.
136+
- **Reject reason**: Why a submitted item was rejected by an admin.
137+
138+
## Frequently asked questions (FAQ)
139+
140+
The following are frequently asked questions related to catalog in Power Platform.
141+
142+
### Where do I provide feedback on catalog?
143+
144+
Ask questions and submit feedback at: [github.com/microsoft/PowerPlatform-Catalog/discussions](https://github.com/microsoft/PowerPlatform-Catalog/discussions)
145+
146+
### What are the items in the catalog?
147+
148+
The catalog items are actually packages. A package contains one or more solutions and some metadata. The [Power Apps](https://make.powerapps.com) experiences can submit individual solutions. The Power Platform CLI experience can be used to create a package containing multiple solutions.
149+
150+
### What are solution templates? What does it mean to install an unmanaged solution?
151+
152+
The use of a [solution](/power-platform/alm/solution-concepts-alm) as a *solution template* is a new scenario we're making available with the catalog. When a maker acquires a solution template, they'll get a new unmanaged copy of that solution. Multiple copies of that [unmanaged solution](/power-platform/alm/solution-concepts-alm#managed-and-unmanaged-solutions) can exist in the same environment and each has a unique identifier.
153+
154+
### Catalog item install looks a lot like solution import. Are they the same thing?
155+
156+
A catalog item is a package that contains one or more solutions. Installation of a package containing a single solution with no other package configuration looks similar to a solution import.
157+
158+
### Will the catalog support PCF components within solutions? What about other solution component types?
159+
160+
Yes, distribution of [PCF controls](/power-apps/developer/component-framework/overview) is made easier by using a catalog. Any [solution component](/power-platform/alm/solution-concepts-alm#solution-components) can be contained in a solution in the catalog.
161+
162+
### Can the templates have multiple owners so people know who to reach out to for more information?
163+
164+
Yes, ownership information is part of the metadata for a catalog item. The ownership can be a group with multiple people in it.
165+
166+
### Is there a way to add documentation such as a user guide when submitting a template?
167+
168+
Yes, documentation links are part of the metadata for a catalog item.
169+
170+
### Can catalogs be shared to security groups?
171+
172+
Yes, catalog permissions can be targeted at [specific security groups](/power-platform/admin/administer-catalog#access-controls).
173+
174+
## Next steps
175+
176+
Learn how to administer the catalog.
177+
178+
> [!div class="nextstepaction"]
179+
> [Administer the catalog](/power-platform/admin/administer-catalog)
180+
181+
Learn how to view, submit, and install catalog items.
182+
183+
> [!div class="nextstepaction"]
184+
> [Submit and install catalog items](submit-acquire-from-catalog.md)
185+
186+
Ask questions or contact the project team on GitHub.
187+
188+
> [!div class="nextstepaction"]
189+
> [github.com/microsoft/PowerPlatform-Catalog/discussions](https://github.com/microsoft/PowerPlatform-Catalog/discussions)
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)