Skip to content

Commit 2a1e681

Browse files
committed
Merge branch 'master' of https://github.com/MicrosoftDocs/powerapps-docs-pr into udag-updated-excel
2 parents c3cfe84 + 522ae00 commit 2a1e681

File tree

449 files changed

+2071
-1256
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

449 files changed

+2071
-1256
lines changed

app-selector2.png

35.1 KB
Loading

powerapps-docs/developer/common-data-service/reference/entities/appmodule.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ These attributes return true for either **IsValidForCreate** or **IsValidForUpda
7575
- [OverriddenCreatedOn](#BKMK_OverriddenCreatedOn)
7676
- [PublishedOn](#BKMK_PublishedOn)
7777
- [PublisherId](#BKMK_PublisherId)
78-
- [UniqueName](#BKMK_UniqueName)
7978
- [URL](#BKMK_URL)
8079
- [WebResourceId](#BKMK_WebResourceId)
8180
- [WelcomePageId](#BKMK_WelcomePageId)
@@ -398,22 +397,6 @@ These attributes return true for either **IsValidForCreate** or **IsValidForUpda
398397
|Type|Lookup|
399398

400399

401-
### <a name="BKMK_UniqueName"></a> UniqueName
402-
403-
|Property|Value|
404-
|--------|-----|
405-
|Description|Unique Name of App Module|
406-
|DisplayName|Unique Name|
407-
|FormatName|Text|
408-
|IsLocalizable|False|
409-
|IsValidForForm|False|
410-
|IsValidForRead|True|
411-
|LogicalName|uniquename|
412-
|MaxLength|100|
413-
|RequiredLevel|SystemRequired|
414-
|Type|String|
415-
416-
417400
### <a name="BKMK_URL"></a> URL
418401

419402
|Property|Value|
@@ -947,4 +930,4 @@ See serviceplan Entity [serviceplan_appmodule](serviceplan.md#BKMK_serviceplan_a
947930

948931
[About the Entity Reference](../about-entity-reference.md)<br />
949932
[Web API Reference](/dynamics365/customer-engagement/web-api/about)<br />
950-
<xref href="Microsoft.Dynamics.CRM.appmodule?text=appmodule EntityType" />
933+
<xref href="Microsoft.Dynamics.CRM.appmodule?text=appmodule EntityType" />

powerapps-docs/developer/common-data-service/webapi/compose-http-requests-handle-errors.md

Lines changed: 87 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Compose HTTP requests and handle errors (Common Data Service)| Microsoft Docs"
33
description: "Read about the HTTP methods and headers that form a part of HTTP requests that interact with the Web API and how to identify and handle errors returned in the response"
44
ms.custom: ""
5-
ms.date: 04/03/2020
5+
ms.date: 08/09/2020
66
ms.service: powerapps
77
ms.suite: ""
88
ms.tgt_pltfrm: ""
@@ -152,7 +152,7 @@ Details about errors are included as JSON in the response. Errors will be in thi
152152
```
153153

154154
> [!IMPORTANT]
155-
> The structure of the error messages is changing. This change is expected to be deployed to different regions over a period starting in late April through May 2020.
155+
> The structure of the error messages is changing. This change is expected to be deployed to different regions over a period starting in August through October 2020.
156156
>
157157
> Before this change, the errors returned were in this format:
158158
>
@@ -176,7 +176,91 @@ Details about errors are included as JSON in the response. Errors will be in thi
176176
>
177177
> If you find that an application you use has a dependency on this property after this change is deployed, you can contact support and request that the change be temporarily removed for your environment. This will provide time for the application developer to make appropriate changes to remove this dependency.
178178
179-
179+
### Include additional details with errors
180+
181+
Some errors can include additional details using *annotations*. When a request includes the `Prefer: odata.include-annotations="*"` header, the response will include all the annotations which will include additional details about errors and a URL that can be used to be directed to any specific guidance for the error.
182+
183+
Some of these details can be set by developers writing plug-ins. For example, let’s say you have a plug-in that throws an error using the [InvalidPluginExecutionException(OperationStatus, Int32, String)](/dotnet/api/microsoft.xrm.sdk.invalidpluginexecutionexception.-ctor#Microsoft_Xrm_Sdk_InvalidPluginExecutionException__ctor_Microsoft_Xrm_Sdk_OperationStatus_System_Int32_System_String_) constructor. This allows you to pass an OperationStatus value, a custom integer error code, and an error message.
184+
185+
A simple plug-in might look like this:
186+
187+
```csharp
188+
namespace MyNamespace
189+
{
190+
public class MyClass : IPlugin
191+
{
192+
public void Execute(IServiceProvider serviceProvider)
193+
{
194+
195+
// Obtain the tracing service
196+
ITracingService tracingService =
197+
(ITracingService)serviceProvider.GetService(typeof(ITracingService));
198+
199+
tracingService.Trace("Entering MyClass plug-in.");
200+
201+
try
202+
{
203+
throw new InvalidPluginExecutionException(OperationStatus.Canceled, 12345, "Example Error Message.");
204+
}
205+
catch (InvalidPluginExecutionException ex)
206+
{
207+
tracingService.Trace("StackTrace:");
208+
tracingService.Trace(ex.StackTrace);
209+
throw ex;
210+
}
211+
}
212+
}
213+
}
214+
```
215+
216+
When this plug-in is registered on the create of an account entity, and the request to create an account includes the `odata.include-annotations="*"` preference, the request and response will look like the following:
217+
218+
**Request**
219+
220+
```http
221+
POST https://yourorg.api.crm.dynamics.com/api/data/v9.1/accounts HTTP/1.1
222+
Content-Type: application/json;
223+
Prefer: odata.include-annotations="*"
224+
{
225+
"name":"Example Account"
226+
}
227+
228+
```
229+
230+
**Response**
231+
232+
```http
233+
HTTP/1.1 400 Bad Request
234+
Content-Type: application/json; odata.metadata=minimal
235+
{
236+
"error": {
237+
"code": "0x80040265",
238+
"message": "Example Error Message.",
239+
"@Microsoft.PowerApps.CDS.ErrorDetails.OperationStatus": "1",
240+
"@Microsoft.PowerApps.CDS.ErrorDetails.SubErrorCode": "12345",
241+
"@Microsoft.PowerApps.CDS.HelpLink": "http://go.microsoft.com/fwlink/?LinkID=398563&error=Microsoft.Crm.CrmException%3a80040265&client=platform",
242+
"@Microsoft.PowerApps.CDS.TraceText": "\r\n[MyNamespace: MyNamespace.MyClass ]\r\n[52e2dbb9-85d3-ea11-a812-000d3a122b89: MyNamespace.MyClass : Create of account] \r\n\r\n Entering MyClass plug-in.\r\nStackTrace:\r\n at MyNamespace.MyClass.Execute(IServiceProvider serviceProvider)\r\n\r\n"
243+
"@Microsoft.PowerApps.CDS.InnerError.Message": "Example Error Message."
244+
}
245+
}
246+
```
247+
248+
This response includes the following annotations:
249+
250+
|Annotation and Description |Value |
251+
|---------|---------|
252+
|`@Microsoft.PowerApps.CDS.ErrorDetails.OperationStatus`<br/>The value of the <xref:Microsoft.Xrm.Sdk.OperationStatus> set by the [InvalidPluginExecutionException(OperationStatus, Int32, String)](/dotnet/api/microsoft.xrm.sdk.invalidpluginexecutionexception.-ctor#Microsoft_Xrm_Sdk_InvalidPluginExecutionException__ctor_Microsoft_Xrm_Sdk_OperationStatus_System_Int32_System_String_) constructor.|`1`|
253+
|`@Microsoft.PowerApps.CDS.ErrorDetails.SubErrorCode`<br/>The value of the `SubErrorCode` set by the [InvalidPluginExecutionException(OperationStatus, Int32, String)](/dotnet/api/microsoft.xrm.sdk.invalidpluginexecutionexception.-ctor#Microsoft_Xrm_Sdk_InvalidPluginExecutionException__ctor_Microsoft_Xrm_Sdk_OperationStatus_System_Int32_System_String_) constructor.|`12345`|
254+
|`@Microsoft.PowerApps.CDS.HelpLink`<br/>A URL that contains information about the error which *may* re-direct you to guidance about how to address the error.|`http://go.microsoft.com/fwlink/?LinkID=398563&error=Microsoft.Crm.CrmException%3a80040265&client=platform`|
255+
|`@Microsoft.PowerApps.CDS.TraceText`<br/>Content written to the Plug-in trace log using the [ITracingService.Trace(String, Object[]) Method](/dotnet/api/microsoft.xrm.sdk.itracingservice.trace). This includes the stacktrace for the plugin because the plug-in author logged it.|`[MyNamespace: MyNamespace.MyClass ]`<br/>`[52e2dbb9-85d3-ea11-a812-000d3a122b89: MyNamespace.MyClass :Create of account]`<br/><br/>`Entering MyClass plug-in.`<br/>`StackTrace:`<br/>` at MyNamespace.MyClass.Execute(IServiceProvider serviceProvider)`|
256+
|`@Microsoft.PowerApps.CDS.InnerError.Message`<br/>The error message found in the InnerError for the exception. This should be the same as the error message except in certain special cases that are for internal use only.|`Example Error Message.`|
257+
258+
> [!NOTE]
259+
> The `@Microsoft.PowerApps.CDS.HelpLink` is not guaranteed to provide guidance for every error. Guidance *may* be provided proactively but most commonly it will be provided reactively based on how frequently the link is used. Please use the link. If it doesn't provide guidance, your use of the link helps us track that people need more guidance about the error. We can then prioritize including guidance to the errors that people need most. The resources that the link may direct you to may be documentation, links to community resources, or external sites.
260+
261+
If you do not want to receive all annotations in the response, you can specify which specific annotations you want to have returned. Rather than using `Prefer: odata.include-annotations="*"`, you can use the following to receive only formatted values for operations that retrieve data and the helplink if an error occurs:
262+
`Prefer: odata.include-annotations="OData.Community.Display.V1.FormattedValue,Microsoft.PowerApps.CDS.HelpLink"`.
263+
180264
### See also
181265

182266
[Perform operations using the Web API](perform-operations-web-api.md)<br />

powerapps-docs/developer/common-data-service/xrm-tooling/use-connection-strings-xrm-tooling-connect.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Create a new connection to Common Data Service using a Application or Client Id
145145
AuthType=Certificate;
146146
url=https://contosotest.crm.dynamics.com;
147147
thumbprint={CertThumbPrintId};
148-
ClientId={AppId};
148+
ClientId={AppId};"
149149
/>
150150
```
151151

@@ -158,7 +158,7 @@ Create a new connection to Common Data Service using a Application or Client Id
158158
AuthType=ClientSecret;
159159
url=https://contosotest.crm.dynamics.com;
160160
ClientId={AppId};
161-
ClientSecret={ClientSecret}
161+
ClientSecret={ClientSecret}"
162162
/>
163163
```
164164

powerapps-docs/developer/model-driven-apps/clientapi/client-scripting-best-practices.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ ms.topic: "article"
66
applies_to:
77
- "Dynamics 365 (online)"
88
ms.assetid: 16271bd8-cfa8-4a7f-802a-60fbff7c3722
9-
author: "KumarVivek"
10-
ms.author: "kvivek"
11-
manager: "annbe"
9+
author: "Nkrb"
10+
ms.author: "nabuthuk"
11+
manager: "kvivek"
1212
search.audienceType:
1313
- developer
1414
search.app:
@@ -17,8 +17,6 @@ search.app:
1717
---
1818
# Best practices: Client scripting in model-driven apps
1919

20-
21-
2220
These are some of the best practice tips you could consider while writing your JavaScript code for model-driven apps.
2321

2422
## Define unique JavaScript function names

powerapps-docs/developer/model-driven-apps/clientapi/clientapi-execution-context.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ ms.topic: "conceptual"
66
applies_to:
77
- "Dynamics 365 (online)"
88
ms.assetid: 1fcbf0fd-4e47-4352-a555-9315f7e57331
9-
author: "KumarVivek"
10-
ms.author: "kvivek"
11-
manager: "annbe"
9+
author: "Nkrb"
10+
ms.author: "nabuthuk"
11+
manager: "kvivek"
1212
search.audienceType:
1313
- developer
1414
search.app:
@@ -17,8 +17,6 @@ search.app:
1717
---
1818
# Client API execution context
1919

20-
21-
2220
The execution context defines the event context in which your code executes. The execution context is passed when an event occurs on a form or grid, which you can use it in your event handler to perform various tasks such as determine [formContext](clientapi-form-context.md) or [gridContext](clientapi-grid-context.md), or manage the save event.
2321

2422
The execution context is passed in one of the following ways:

powerapps-docs/developer/model-driven-apps/clientapi/clientapi-form-context.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ ms.topic: "conceptual"
66
applies_to:
77
- "Dynamics 365 (online)"
88
ms.assetid: 0cf94e8d-801a-451f-98c3-130e912f963b
9-
author: "KumarVivek"
10-
ms.author: "kvivek"
11-
manager: "annbe"
9+
author: "Nkrb"
10+
ms.author: "nabuthuk"
11+
manager: "kvivek"
1212
search.audienceType:
1313
- developer
1414
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/clientapi-grid-context.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ ms.topic: "conceptual"
66
applies_to:
77
- "Dynamics 365 (online)"
88
ms.assetid: f884d7d4-31e6-4080-acd9-493e81e6b278
9-
author: "KumarVivek"
10-
ms.author: "kvivek"
11-
manager: "annbe"
9+
author: "Nkrb"
10+
ms.author: "nabuthuk"
11+
manager: "kvivek"
1212
search.audienceType:
1313
- developer
1414
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/clientapi-xrm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ ms.topic: "conceptual"
77
applies_to:
88
- "Dynamics 365 (online)"
99
ms.assetid: 15272ad9-25d7-499e-9361-a65f789daf20
10-
author: "KumarVivek"
11-
ms.author: "kvivek"
12-
manager: "annbe"
10+
author: "Nkrb"
11+
ms.author: "nabuthuk"
12+
manager: "kvivek"
1313
search.audienceType:
1414
- developer
1515
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/debug-JavaScript-code.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ ms.topic: "conceptual"
66
applies_to:
77
- "Dynamics 365 (online)"
88
ms.assetid: 3edad039-4397-4984-a29b-9307a7a2aaee
9-
author: "KumarVivek"
10-
ms.author: "kvivek"
11-
manager: "annbe"
9+
author: "Nkrb"
10+
ms.author: "nabuthuk"
11+
manager: "kvivek"
1212
search.audienceType:
1313
- developer
1414
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/events-forms-grids.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ ms.service: powerapps
55
ms.topic: "reference"
66
applies_to: "Dynamics 365 (online)"
77
ms.assetid: 9fb38429-55ef-45ce-a3a3-e649e1be89d0
8-
author: "KumarVivek"
9-
ms.author: "kvivek"
10-
manager: "annbe"
8+
author: "Nkrb"
9+
ms.author: "nabuthuk"
10+
manager: "kvivek"
1111
search.audienceType:
1212
- developer
1313
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/reference.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ ms.topic: "conceptual"
77
applies_to:
88
- "Dynamics 365 (online)"
99
ms.assetid:
10-
author: "KumarVivek"
11-
ms.author: "kvivek"
12-
manager: "annbe"
10+
author: "Nkrb"
11+
ms.author: "nabuthuk"
12+
manager: "kvivek"
1313
search.audienceType:
1414
- developer
1515
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/reference/GetGlobalContext-ClientGlobalContext.js.aspx.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ ms.date: 04/15/2020
44
ms.service: powerapps
55
ms.topic: "conceptual"
66
ms.assetid: b58e6173-e3cd-4a3b-b39a-334c295503ec
7-
author: "KumarVivek"
8-
ms.author: "kvivek"
9-
manager: "annbe"
7+
author: "Nkrb"
8+
ms.author: "nabuthuk"
9+
manager: "kvivek"
1010
search.audienceType:
1111
- developer
1212
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/reference/Xrm-App/addGlobalNotification.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: "addGlobalNotification (Client API reference) in model-driven apps| Micro
33
ms.date: 03/09/2020
44
ms.service: powerapps
55
ms.topic: "reference"
6-
author: "KumarVivek"
7-
ms.author: "kvivek"
8-
manager: "annbe"
6+
author: "Nkrb"
7+
ms.author: "nabuthuk"
8+
manager: "kvivek"
99
search.audienceType:
1010
- developer
1111
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/reference/Xrm-App/clearGlobalNotification.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: "clearGlobalNotification (Client API reference) in model-driven apps| Mic
33
ms.date: 03/09/2020
44
ms.service: powerapps
55
ms.topic: "reference"
6-
author: "KumarVivek"
7-
ms.author: "kvivek"
8-
manager: "annbe"
6+
author: "Nkrb"
7+
ms.author: "nabuthuk"
8+
manager: "kvivek"
99
search.audienceType:
1010
- developer
1111
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/reference/Xrm-Device/captureAudio.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ ms.service: powerapps
55
ms.topic: "reference"
66
applies_to: "Dynamics 365 (online)"
77
ms.assetid: fa39d18e-4b82-423a-84a0-e54450b7964e
8-
author: "KumarVivek"
9-
ms.author: "kvivek"
10-
manager: "annbe"
8+
author: "Nkrb"
9+
ms.author: "nabuthuk"
10+
manager: "kvivek"
1111
search.audienceType:
1212
- developer
1313
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/reference/Xrm-Device/captureImage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ ms.service: powerapps
55
ms.topic: "reference"
66
applies_to: "Dynamics 365 (online)"
77
ms.assetid: 1b24e8b2-20af-4e75-8c00-1aa393c07aef
8-
author: "KumarVivek"
9-
ms.author: "kvivek"
10-
manager: "annbe"
8+
author: "Nkrb"
9+
ms.author: "nabuthuk"
10+
manager: "kvivek"
1111
search.audienceType:
1212
- developer
1313
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/reference/Xrm-Device/captureVideo.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ ms.service: powerapps
55
ms.topic: "reference"
66
applies_to: "Dynamics 365 (online)"
77
ms.assetid: 9580d05a-a91f-4126-b94b-4d1068da35fa
8-
author: "KumarVivek"
9-
ms.author: "kvivek"
10-
manager: "annbe"
8+
author: "Nkrb"
9+
ms.author: "nabuthuk"
10+
manager: "kvivek"
1111
search.audienceType:
1212
- developer
1313
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/reference/Xrm-Device/getBarcodeValue.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ ms.service: powerapps
55
ms.topic: "reference"
66
applies_to: "Dynamics 365 (online)"
77
ms.assetid: 0218b96c-2809-4f2d-9f9f-d8ee8f8e3b7b
8-
author: "KumarVivek"
9-
ms.author: "kvivek"
10-
manager: "annbe"
8+
author: "Nkrb"
9+
ms.author: "nabuthuk"
10+
manager: "kvivek"
1111
search.audienceType:
1212
- developer
1313
search.app:

powerapps-docs/developer/model-driven-apps/clientapi/reference/Xrm-Device/getCurrentPosition.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ ms.service: powerapps
55
ms.topic: "reference"
66
applies_to: "Dynamics 365 (online)"
77
ms.assetid: 062a52d8-170c-4e98-b48a-ac99ec759f83
8-
author: "KumarVivek"
9-
ms.author: "kvivek"
10-
manager: "annbe"
8+
author: "Nkrb"
9+
ms.author: "nabuthuk"
10+
manager: "kvivek"
1111
search.audienceType:
1212
- developer
1313
search.app:

0 commit comments

Comments
 (0)