Skip to content

Commit be2be9a

Browse files
committed
Updates
1 parent e5c8efd commit be2be9a

10 files changed

+56
-343
lines changed

powerapps-docs/developer/component-framework/reference/context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ The resource interface of `context.resource`
7070

7171
### updatedProperties
7272

73-
An array of strings indicated which values have changed on the context object since the last time it was passed to this component.
73+
An array of strings with values that have changed since the last time it was passed and [parameters](#parameters). `updatesProperties` is currently only supported for model-driven apps and always returns empty string for canvas apps.
7474

7575
**Type**: `string[]`
7676

powerapps-docs/developer/model-driven-apps/export-ribbon-definitions.md

Lines changed: 25 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
title: "Export ribbon definitions (model-driven apps) | Microsoft Docs" # Intent and product brand in a unique string of 43-59 chars including spaces
33
description: "Learn about exporting the ribbon definitions." # 115-145 characters including spaces. This abstract displays in the search result.
44
ms.custom: ""
5-
ms.date: 10/31/2018
5+
ms.date: 04/30/2020
66
ms.reviewer: ""
77
ms.service: powerapps
88
ms.topic: "article"
9-
author: "KumarVivek" # GitHub ID
10-
ms.author: "kvivek" # MSFT alias of Microsoft employees only
11-
manager: "shilpas" # MSFT alias of manager or PM counterpart
9+
author: "nkrb" # GitHub ID
10+
ms.author: "nabuthuk" # MSFT alias of Microsoft employees only
11+
manager: "kvivek" # MSFT alias of manager or PM counterpart
1212
search.audienceType:
1313
- developer
1414
search.app:
@@ -17,21 +17,15 @@ search.app:
1717
---
1818
# Export ribbon definitions
1919

20-
<!-- https://docs.microsoft.com/dynamics365/customer-engagement/developer/customize-dev/export-ribbon-definitions -->
21-
2220
To effectively define changes to the default RibbonXml, you must be able to reference the RibbonXml data that defines those ribbons.
2321

24-
<a name="BKMK_AccessRibbonDefinitionsForYourOrganization"></a>
25-
2622
## Access the ribbon definitions for your organization
2723

28-
If the Ribbon for your organization has been modified, you should export the current definitions if you intend to work with the customized ribbon elements. To do this, use the exportribbonxml sample located at `SampleCode\CS\Client\Ribbon\ExportRibbonXml`.
24+
If the Ribbon for your organization has been modified, you should export the current definitions if you intend to work with the customized ribbon elements. To do this, use the [Export Ribbon xml](https://github.com/microsoft/PowerApps-Samples/tree/master/cds/orgsvc/C%23/ExportRibbonDefinitions) sample.
2925

30-
<a name="BKMK_AccessDefaultRibbonData"></a>
31-
3226
## Access the default ribbon data
3327

34-
The default ribbon definitions for Model-driven apps can be downloaded from [Microsoft Downloads: ExportedRibbonXml.zip](https://download.microsoft.com/download/C/2/A/C2A79C47-DD2D-4938-A595-092CAFF32D6B/ExportedRibbonXml.zip).
28+
The default ribbon definitions for model-driven apps can be downloaded from [Microsoft Downloads: ExportedRibbonXml.zip](https://download.microsoft.com/download/C/2/A/C2A79C47-DD2D-4938-A595-092CAFF32D6B/ExportedRibbonXml.zip).
3529

3630
The applicationRibbon.xml file contains the definition of the core application ribbons.
3731

@@ -48,6 +42,7 @@ To effectively define changes to the default RibbonXml, you must be able to refe
4842
### Decompress the ribbon data
4943

5044
The ribbon data is exported as a compressed file. To decompress the file into XML you have to use the [System.IO.Packaging.ZipPackage](https://msdn.microsoft.com/library/system.io.packaging.zippackage.aspx) class. The following example is a helper method used in the SDK sample to decompress the file.
45+
5146
``` C#
5247
/// <summary>
5348
/// A helper method that decompresses the Ribbon data returned
@@ -78,10 +73,11 @@ public byte[] unzipRibbon(byte[] data)
7873
### Retrieve the application ribbon data
7974

8075
The application ribbon can be retrieved using the <xref:Microsoft.Crm.Sdk.Messages.RetrieveApplicationRibbonRequest> as shown in the following sample.
76+
8177
```C#
82-
//Retrieve the Appliation Ribbon
83-
RetrieveApplicationRibbonRequest appribReq = new RetrieveApplicationRibbonRequest();
84-
RetrieveApplicationRibbonResponse appribResp = (RetrieveApplicationRibbonResponse)_serviceProxy.Execute(appribReq);
78+
//Retrieve the Application Ribbon
79+
var appribReq = new RetrieveApplicationRibbonRequest();
80+
var appribResp = (RetrieveApplicationRibbonResponse)service.Execute(appribReq);
8581

8682
System.String applicationRibbonPath = Path.GetFullPath(exportFolder + "\\applicationRibbon.xml");
8783
File.WriteAllBytes(applicationRibbonPath, unzipRibbon(appribResp.CompressedApplicationRibbonXml));
@@ -92,9 +88,10 @@ File.WriteAllBytes(applicationRibbonPath, unzipRibbon(appribResp.CompressedAppli
9288
To retrieve the ribbon definition for entities, you can just include the name of the entity as a parameter to the <xref:Microsoft.Crm.Sdk.Messages.RetrieveEntityRibbonRequest>.
9389

9490
To retrieve the ribbon definitions for all entities that support the ribbon you need a list of those system entities that have ribbon definitions that vary from the entity ribbon template. The following sample shows an array of all the system entities that have ribbon definitions.
91+
9592
```C#
9693
//This array contains all of the system entities that use the ribbon.
97-
public System.String[] entitiesWithRibbons = {"account",
94+
public System.String[] entitiesWithRibbons = {"account",
9895
"activitymimeattachment",
9996
"activitypointer",
10097
"appointment",
@@ -175,45 +172,40 @@ File.WriteAllBytes(applicationRibbonPath, unzipRibbon(appribResp.CompressedAppli
175172
"userquery"};
176173
```
177174

178-
The following sample shows how to retrieve the ribbon definitions for a set of entities.
179-
180-
```C#
181-
//Retrieve system Entity Ribbons
182-
RetrieveEntityRibbonRequest entRibReq = new RetrieveEntityRibbonRequest() { RibbonLocationFilter = RibbonLocationFilters.All };
175+
The following sample shows how to retrieve the ribbon definitions for a set of entities.
183176

177+
```csharp
178+
//Retrieve system Entity Ribbons
179+
var entRibReq = new RetrieveEntityRibbonRequest() { RibbonLocationFilter = RibbonLocationFilters.All };
184180
foreach (System.String entityName in entitiesWithRibbons)
185181
{
186182
entRibReq.EntityName = entityName;
187-
RetrieveEntityRibbonResponse entRibResp = (RetrieveEntityRibbonResponse)_serviceProxy.Execute(entRibReq);
183+
var entRibResp = (RetrieveEntityRibbonResponse)service.Execute(entRibReq);
188184

189185
System.String entityRibbonPath = Path.GetFullPath(exportFolder + "\\" + entityName + "Ribbon.xml");
190186
File.WriteAllBytes(entityRibbonPath, unzipRibbon(entRibResp.CompressedEntityXml));
191187
//Write the path where the file has been saved.
192188
Console.WriteLine(entityRibbonPath);
193189
}
194-
```
195-
Any custom entities also support ribbon customizations. To get a list of custom entities, use the <xref:Microsoft.Xrm.Sdk.Messages.RetrieveAllEntitiesRequest> and retrieve the names of custom entities. The following sample shows how to retrieve ribbon definitions for all custom entities.
190+
```
191+
Any custom entities also support ribbon customizations. To get a list of custom entities, use the <xref:Microsoft.Xrm.Sdk.Messages.RetrieveAllEntitiesRequest> and retrieve the names of custom entities. The following sample shows how to retrieve ribbon definitions for all custom entities.
196192

197-
```C#
193+
```csharp
198194
//Check for custom entities
199-
RetrieveAllEntitiesRequest raer = new RetrieveAllEntitiesRequest() { EntityFilters = EntityFilters.Entity };
200-
201-
RetrieveAllEntitiesResponse resp = (RetrieveAllEntitiesResponse)_serviceProxy.Execute(raer);
202-
195+
var raer = new RetrieveAllEntitiesRequest() { EntityFilters = EntityFilters.Entity };
196+
var resp = (RetrieveAllEntitiesResponse)service.Execute(raer);
203197
foreach (EntityMetadata em in resp.EntityMetadata)
204198
{
205199
if (em.IsCustomEntity == true && em.IsIntersect == false)
206200
{
207201
entRibReq.EntityName = em.LogicalName;
208-
RetrieveEntityRibbonResponse entRibResp = (RetrieveEntityRibbonResponse)_serviceProxy.Execute(entRibReq);
209-
202+
var entRibResp = (RetrieveEntityRibbonResponse)service.Execute(entRibReq);
210203
System.String entityRibbonPath = Path.GetFullPath(exportFolder + "\\" + em.LogicalName + "Ribbon.xml");
211204
File.WriteAllBytes(entityRibbonPath, unzipRibbon(entRibResp.CompressedEntityXml));
212205
//Write the path where the file has been saved.
213206
Console.WriteLine(entityRibbonPath);
214207
}
215-
}
216-
}
208+
}
217209
```
218210

219211
## Troubleshoot ribbon issues

powerapps-docs/developer/model-driven-apps/open-forms-views-dialogs-reports-url.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,12 +181,12 @@ function openDialogProcess(dialogId, entityName, objectId)
181181
Two possible values for this parameter are `run` or `filter`. When `run` is used, the report will be displayed using the default filters. When `filter` is used, the report will display a filter that the user can edit before choosing the **Run Report** button to view the report.
182182

183183
**helpID**
184-
This parameter is optional. For reports that are included with Model-driven apps the value in this parameter allows the **Help** button to display appropriate content about this report when **Help on This Page** is chosen. The value should correspond to the report `FileName` attribute value.
184+
This parameter is optional. For reports that are included with model-driven apps the value in this parameter allows the **Help** button to display appropriate content about this report when **Help on This Page** is chosen. The value should correspond to the report `FileName` attribute value.
185185

186186
**id**
187187
This parameter is the report `ReportId` attribute value.
188188

189-
The following examples show URLs that can be used to open reports in MDA.
189+
The following examples show URLs that can be used to open reports in model-driven apps.
190190

191191
Open the **Neglected Cases** report using the default filter:
192192
```

powerapps-docs/developer/model-driven-apps/pass-parameters-url-by-using-ribbon.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Ribbon actions are defined in the `<Actions>` element of a `<CommandDefinition>`
4242
[!INCLUDE[languagecode](../../includes/languagecode.md)]
4343

4444
> [!NOTE]
45-
> We recommend that you use the entity name instead of the entity type code because the entity type code may be different between MDA installations.
45+
> We recommend that you use the entity name instead of the entity type code because the entity type code may be different between model-driven apps installations.
4646
4747
### Example
4848
The following sample shows the URL without parameters:

powerapps-docs/developer/model-driven-apps/query-and-edit-an-organization-theme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ OData-Version: 4.0
9696
|LogoId|String|null|The name of a web resource to use as a logo. Recommended dimensions are a height of 50 pixels and a maximum width of 400 pixels.|
9797
|LogoToolTip|String|Model-driven apps|The text that will be used as the tooltip and alt text for the logo.|
9898
|MainColor|String|#3B79B7|The Unified Interface primary theme color to be used on main command bar, buttons and tabs.|
99-
|Name|String|MDA Default Theme|The name of the Theme entity.|
99+
|Name|String|Model-driven apps Default Theme|The name of the Theme entity.|
100100
|NavBarBackgroundColor|String|#002050|The primary navigation bar color.|
101101
|NavBarShelfColor|String|#DFE2E8|The secondary navigation bar color.|
102102
|OverriddenCreatedOn|DateTime|null|Date and time that the record was migrated.|

powerapps-docs/developer/model-driven-apps/ribbons-available.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ When you write your change definitions, you will frequently need to reference th
3232

3333
Because of this requirement to reference the definitions of existing ribbon elements, it is very important to understand the current ribbon definitions in your organization. There are two messages you can use to export XML files representing the current state of your ribbons. These definitions include any customizations that have already been applied to your system so that you can customize any custom ribbons that were previously applied. For more information, see [Export Ribbon Definitions](export-ribbon-definitions.md).
3434

35-
To help you get started, you can download the default ribbon definitions for MDA from [Microsoft Downloads: ExportedRibbonXml.zip](https://download.microsoft.com/download/C/2/A/C2A79C47-DD2D-4938-A595-092CAFF32D6B/ExportedRibbonXml.zip). The ExportedRibbonXml.zip file includes the output files you would have for an organization with a ribbon that has not been customized. You don’t need to run the sample application to export this data. If you have a customized ribbon, you should run the sample application to refresh the files in this folder with any customizations previously applied for your organization.
35+
To help you get started, you can download the default ribbon definitions for model-driven apps from [Export Ribbon Definitions sample](https://github.com/microsoft/PowerApps-Samples/tree/master/cds/orgsvc/C%23/ExportRibbonDefinitions). `The ExportedRibbonXml` file includes the output files you would have for an organization.
3636

3737
Within the exported ribbon XML files, the applicationRibbon.xml file includes all the ribbons that are not defined for a specific entity. These correspond to the **Application Ribbons** solution component. For each entity, you will find an *entity name*ribbon.xml file. This corresponds to the `RibbonDiffXml` that is included in each entity. If you want to edit the ribbon for a specific entity, you should locate the ribbon XML file for that entity.
3838

@@ -131,7 +131,7 @@ All entities use a common ribbon definition called the *Entity Ribbon Template*.
131131

132132
<a name="BKMK_BasicHomeTab"></a>
133133
## Basic home tab
134-
The basic home tab is displayed on the main application ribbon whenever an alternative tab is not defined because of entity context or a display rule that suppresses it for specific pages. For example, this tab is displayed when you view the MDA**Help**. The Id of the basic home tab is `Mscrm.BasicHomeTab`.
134+
The basic home tab is displayed on the main application ribbon whenever an alternative tab is not defined because of entity context or a display rule that suppresses it for specific pages. For example, this tab is displayed when you view the model-driven apps **Help**. The Id of the basic home tab is `Mscrm.BasicHomeTab`.
135135

136136
<!-- [!NOTE]-->
137137
<!-- > The Jewel that was shown in [!INCLUDE[pn_crm2011_and_online](../../includes/pn-crm2011-and-online.md)] is no longer displayed. Changes to the Jewel will not appear in [!INCLUDE[pn_dynamics_crm_online](../../includes/pn-dynamics-crm-online.md)] -->
@@ -148,7 +148,7 @@ All entities use a common ribbon definition called the *Entity Ribbon Template*.
148148

149149
<a name="other_ribbons"></a>
150150
## Other ribbons
151-
Several other special purpose ribbon tabs and a contextual group are defined by MDA.
151+
Several other special purpose ribbon tabs and a contextual group are defined by model-driven apps.
152152
Each tab is associated with a specific `<TabDisplayRule>` that controls when they will display. The following table lists these tabs.
153153

154154

powerapps-docs/developer/model-driven-apps/sample-charts.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ This topic contains sample charts along with the respective data description and
8686

8787
<a name="BarChart"></a>
8888
## Bar Chart
89-
The following is a bar chart that shows the top 10 customers. This is one of the default charts available in MDA for the `Opportunity` entity.
89+
The following is a bar chart that shows the top 10 customers. This is one of the default charts available in model-driven apps for the `Opportunity` entity.
9090

9191
![Sample bar chart: Top 10 Customers](media/charts-top-10-customers.gif "Sample bar chart: Top 10 Customers")
9292

@@ -206,7 +206,7 @@ This topic contains sample charts along with the respective data description and
206206

207207
<a name="LineChart"></a>
208208
## Line Chart
209-
The following is a line chart that shows the number of leads generated in the last five months. This is one of the default charts available in MDA for the `Lead` entity.
209+
The following is a line chart that shows the number of leads generated in the last five months. This is one of the default charts available in model-driven apps for the `Lead` entity.
210210

211211
![Sample line chart: Lead Generation Rate](media/lead-generation-rate-chart.png "Sample line chart: Lead Generation Rate") -->
212212

@@ -263,7 +263,7 @@ This topic contains sample charts along with the respective data description and
263263

264264
<a name="PieChart"></a>
265265
## Pie Chart
266-
The following is a pie chart that shows the total number of leads and their importance. This is one of the default charts available in MDA for the `Lead` entity.
266+
The following is a pie chart that shows the total number of leads and their importance. This is one of the default charts available in model-driven apps for the `Lead` entity.
267267

268268
![Sample pie chart: Leads by Rating](media/leads-by-source-chart.png "Sample pie chart: Leads by Rating")
269269

@@ -317,7 +317,7 @@ This topic contains sample charts along with the respective data description and
317317

318318
<a name="FunnelChart"></a>
319319
## Funnel Chart
320-
The following is a funnel chart that shows the sum of estimated revenue in each stage of the sales pipeline. This is one of the default charts available in MDA for the `Opportunity` entity.
320+
The following is a funnel chart that shows the sum of estimated revenue in each stage of the sales pipeline. This is one of the default charts available in model-driven apps for the `Opportunity` entity.
321321

322322
![Sample funnel chart: Sales Pipeline](media/charts-sales-pipeline-chart.png "Sample funnel chart: Sales Pipeline")
323323

@@ -373,7 +373,7 @@ This topic contains sample charts along with the respective data description and
373373

374374
## Multi-Series Chart
375375

376-
The following is a multi-series chart that shows the estimated vs. actual revenue closed by month. You can use the chart designer in MDA or methods described in the developer documentation to create these types of charts.
376+
The following is a multi-series chart that shows the estimated vs. actual revenue closed by month. You can use the chart designer in model-driven apps or methods described in the developer documentation to create these types of charts.
377377

378378
A multi-series chart has multiple `<measurecollection>` elements in the data description, each mapping to the corresponding `<Series>` element in the presentation description XML string.
379379

@@ -452,7 +452,7 @@ This topic contains sample charts along with the respective data description and
452452

453453
<a name="ComparisonChart"></a>
454454
## Comparison Chart (Stacked Chart)
455-
The following is a comparison chart that shows the number of activities by type and priority. You can use the chart designer in MDA or methods described in the developer documentation to create these types of charts.
455+
The following is a comparison chart that shows the number of activities by type and priority. You can use the chart designer in model-driven apps or methods described in the developer documentation to create these types of charts.
456456

457457
A comparison chart has two `groupby` clauses in the data description XML.
458458

@@ -519,7 +519,7 @@ This topic contains sample charts along with the respective data description and
519519

520520
## Comparison Chart (100% Stacked Chart)
521521

522-
The following is a comparison chart that shows the number of cases opened on any date, grouped by priority. You can use the chart designer in MDA or methods available in the Web Services to create these types of charts.
522+
The following is a comparison chart that shows the number of cases opened on any date, grouped by priority. You can use the chart designer in model-driven apps or methods available in the Web Services to create these types of charts.
523523

524524
A comparison chart has two `groupby` clauses in the data description XML.
525525

0 commit comments

Comments
 (0)