You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: powerapps-docs/developer/common-data-service/api-limits.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ Client application developers should not simply throw the error to display the m
41
41
42
42
### Data integration applications
43
43
44
-
Applications designed to load data into CDS or perform bulk updates must also be able to manage service protection API limit errors. These applications prioritize throughput so they can complete their work in the minimum amount of time. These applications must have a strategy to retry operations. There are several strategies that they can apply to get the maximum throughput. More information: [How to maximize throughput](#how-to-maximize-throughput).
44
+
Applications designed to load data into Dataverse or perform bulk updates must also be able to manage service protection API limit errors. These applications prioritize throughput so they can complete their work in the minimum amount of time. These applications must have a strategy to retry operations. There are several strategies that they can apply to get the maximum throughput. More information: [How to maximize throughput](#how-to-maximize-throughput).
45
45
46
46
### Portal applications
47
47
@@ -235,7 +235,7 @@ This section describes ways that you can design your clients and systems to avoi
235
235
236
236
### Update your client application
237
237
238
-
Service Protection API limits have been applied to CDS since 2018, but there are many client applications written before these limits existed. These clients didn't expect these errors and can't handle the errors correctly. You should update these applications and apply the patterns described in the [Using the Organization Service](#using-the-organization-service) or [Using the Web API](#using-the-web-api) sections below.
238
+
Service Protection API limits have been applied to Dataverse since 2018, but there are many client applications written before these limits existed. These clients didn't expect these errors and can't handle the errors correctly. You should update these applications and apply the patterns described in the [Using the Organization Service](#using-the-organization-service) or [Using the Web API](#using-the-web-api) sections below.
Copy file name to clipboardExpand all lines: powerapps-docs/developer/common-data-service/best-practices/business-logic/use-invalidpluginexecutionexception-plugin-workflow-activities.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,7 @@ Failure to convert the message into a <xref:Microsoft.Xrm.Sdk.InvalidPluginExecu
59
59
60
60
Do not use HTML within error message text.
61
61
62
-
Web applications which access CDS data should HTML encode any error message text before they display it to a user. This will prevent any HTML in your message from rendered as you intend. It will just show the HTML code.
62
+
Web applications which access Dataverse data should HTML encode any error message text before they display it to a user. This will prevent any HTML in your message from rendered as you intend. It will just show the HTML code.
Copy file name to clipboardExpand all lines: powerapps-docs/developer/common-data-service/best-practices/business-logic/verify-certification-dependencies.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ You should verify that the site you want to connect with has a valid chain of ce
51
51
52
52
You may encounter this when connecting to a new endpoint for the first time or when something about the certificate has changed.
53
53
54
-
When the code in your plug-in running in the sandbox attempts to connect to an external endpoint using https, the CDS Sandbox will start SSL/TLS negotiation. The endpoint presents a certificate to use for encryption. If the certificate has one or more intermediate certificates it must present the entire chain to successfully complete SSL/TLS negotiation. If the complete chain is not presented SSL/TLS communication cannot be established.
54
+
When the code in your plug-in running in the sandbox attempts to connect to an external endpoint using https, the Dataverse Sandbox will start SSL/TLS negotiation. The endpoint presents a certificate to use for encryption. If the certificate has one or more intermediate certificates it must present the entire chain to successfully complete SSL/TLS negotiation. If the complete chain is not presented SSL/TLS communication cannot be established.
Copy file name to clipboardExpand all lines: powerapps-docs/developer/common-data-service/custom-actions.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ There are now two ways to define custom messages:
26
26
27
27
|Custom message method |Description |
28
28
|---------|---------|
29
-
|Workflow Custom Action|Also known as simply *Custom Actions*, these have been part of CDS for many years. Workflow Custom Actions provide a no-code way to define a custom message using the Workflow designer. The logic in these workflows can also be extended with code by using custom workflow activities. More information: [Use Workflow Custom Actions with code](workflow-custom-actions.md)|
29
+
|Workflow Custom Action|Also known as simply *Custom Actions*, these have been part of Dataverse for many years. Workflow Custom Actions provide a no-code way to define a custom message using the Workflow designer. The logic in these workflows can also be extended with code by using custom workflow activities. More information: [Use Workflow Custom Actions with code](workflow-custom-actions.md)|
30
30
|Custom API| This new capability is a preview feature that extends the concept of custom actions to provide developers with capabilities not limited by the workflow designer. More information: [Create and use Custom APIs](custom-api.md)|
31
31
32
32
Many developers have been creating workflow custom actions simply to create new messages without implementing any logic in the workflow. Instead, they register plug-ins for the message created by the custom action to implement all of their logic. The Custom API feature makes this pattern a first class capability for developers to extend Dataverse.
@@ -44,7 +44,7 @@ The following table describes some of the different capabilities.
44
44
|Block Extension by other plug-ins|No|Yes|All messages defined using Workflow Custom Actions are extensible. This means any 3rd party developer can apply additional logic in a plug-in registered on the `PreValidation`, `PreOperation`, or `PostOperation` stages of the message to change the behavior.<br /><br />If a 3rd party plug-in step is synchronous, it means that logic or errors in plug-ins that extend your message can cause the message defined by a Workflow Custom Action to fail. With a Custom API you can block this.|
45
45
|Make message private|No|Yes|When you create a message using a Workflow Custom Action, it is exposed publicly in the endpoint for anyone else to discover and use. If someone else takes a dependency on the message you created, their code will be broken if you remove, rename, or change the input or output parameter signature in the future.<br /><br />If you do not intend for your message to be used by anyone else, you can mark it as a private message. This will indicate that you do not support others using the message you create, and it will not be included in definitions of available functions or actions exposed by the Web API $metadata service definition. Classes for calling these messages will not be generated using code generation tools.|
46
46
|Localizable names and descriptions|No|Yes|While Workflow Custom Actions provide for a friendly name for the custom action and any input and output parameters it uses, these values are not localizable. With Custom API you can provide localizable names and descriptions. These localized strings can then be bound to controls that provide a UI to use the message.|
47
-
|Create OData Function|No|Yes| The CDS Web API is an OData web service. OData provides for two types of operations: *Actions* & *Functions*.<br /><ul><li>An **Action** is an operation that makes changes to data in the system. It is invoked using the Http POST method and parameters are passed in the body of the request.</li><li>A **Function** is an operation that makes no change to data, for example an operation that simply retrieves data. It is invoked using an Http GET method and the parameters are passed in the URL of the request</li></ul>There is nothing to prevent you from defining all operations as Actions if you wish. But some operations may be best expressed using a GET request available by defining a function.|
47
+
|Create OData Function|No|Yes| The Dataverse Web API is an OData web service. OData provides for two types of operations: *Actions* & *Functions*.<br /><ul><li>An **Action** is an operation that makes changes to data in the system. It is invoked using the Http POST method and parameters are passed in the body of the request.</li><li>A **Function** is an operation that makes no change to data, for example an operation that simply retrieves data. It is invoked using an Http GET method and the parameters are passed in the URL of the request</li></ul>There is nothing to prevent you from defining all operations as Actions if you wish. But some operations may be best expressed using a GET request available by defining a function.|
48
48
|Create a global operation not bound to an entity|Yes|Yes|Both provide the ability to define a global message not bound to an entity.|
49
49
|Bind an operation to an entity|Yes|Yes|Both provide the ability to pass a reference to a specific entity record by binding it to an entity.|
50
50
|Bind an operation to an entity collection|No|Yes|Binding an operation to an entity collection allows for another way to accept an entity collection as a required parameter value for operation. |
Copy file name to clipboardExpand all lines: powerapps-docs/developer/common-data-service/custom-api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ search.app:
19
19
20
20
[This topic is pre-release documentation and is subject to change.]
21
21
22
-
Custom APIs offer a new code-first way to define messages that you can add to CDS web services. Conceptually, Custom APIs are an extension to Custom Actions that have provided a no-code way to include custom messages. To differentiate between the two different kinds of Custom Action, we will use *Workflow Custom Action* to refer to the no-code capabilities that depend on workflow. *Custom API* will refer to the type of custom action that depends on a developer to write a plug-in.
22
+
Custom APIs offer a new code-first way to define messages that you can add to Dataverse web services. Conceptually, Custom APIs are an extension to Custom Actions that have provided a no-code way to include custom messages. To differentiate between the two different kinds of Custom Action, we will use *Workflow Custom Action* to refer to the no-code capabilities that depend on workflow. *Custom API* will refer to the type of custom action that depends on a developer to write a plug-in.
23
23
24
24
Custom APIs provide a capabilities specifically for developers to define their logic in code. For a full comparison of Workflow Custom Action and Custom API, see [Compare Workflow Custom Action and Custom API](custom-actions.md#compare-workflow-custom-action-and-custom-api).
Power Apps offers users, businesses, independent software vendors (ISVs), and systems integrators (SIs) a powerful platform for building line-of-business apps. **Common Data Service** is the underlying data platform for Power Apps that contains the core functionality such as server-side logic (plug-ins and workflows), business process flows, a highly sophisticated security model, and an extensible platform for developers to build apps.
22
+
Power Apps offers users, businesses, independent software vendors (ISVs), and systems integrators (SIs) a powerful platform for building line-of-business apps. Microsoft Dataverse is the underlying data platform for Power Apps that contains the core functionality such as server-side logic (plug-ins and workflows), business process flows, a highly sophisticated security model, and an extensible platform for developers to build apps.
23
23
24
24
There are many aspects to how developers can contribute to creating apps that use Dataverse. While it is possible to build an application with code using Dataverse as your data source, most projects will use either [model-driven apps](/powerapps/maker/model-driven-apps/model-driven-app-overview) or [canvas apps](/powerapps/maker/canvas-apps/getting-started) to generate the experience that people will use.
Copy file name to clipboardExpand all lines: powerapps-docs/developer/common-data-service/walkthrough-register-azure-aware-plug-in-using-plug-in-registration-tool.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,9 +28,9 @@ This walkthrough demonstrates how to register a service endpoint step using the
28
28
The following prerequisites must be completed before you start this walkthrough:
29
29
30
30
- Access to the Plug-in Registration Tool. [!INCLUDE[proc-download-plugin-registration-tool](../../includes/proc-download-plugin-registration-tool.md)]
31
-
- Your CDS system user account must have the System Customizer or System Administrator role.
32
-
- Have access to a Azure platform service namespace that is configured for SAS authorization, to which CDS will post a message.
33
-
- If you plan to use any other Azure messaging entity other than a queue, for example a relay, there must be a listener application actively listening to the specified solution endpoint for CDS to successfully post to the Azure Service Bus. For more information, see [Write a Listener for an Azure Solution](write-listener-application-azure-solution.md).
31
+
- Your Dataverse system user account must have the System Customizer or System Administrator role.
32
+
- Have access to a Azure platform service namespace that is configured for SAS authorization, to which Dataverse will post a message.
33
+
- If you plan to use any other Azure messaging entity other than a queue, for example a relay, there must be a listener application actively listening to the specified solution endpoint for Dataverse to successfully post to the Azure Service Bus. For more information, see [Write a Listener for an Azure Solution](write-listener-application-azure-solution.md).
34
34
- A configured service endpoint with SAS authorization is available in the target organization. More information: [Walkthrough: Configure Microsoft Azure (SAS) for integration with CDS](walkthrough-configure-azure-sas-integration.md).
35
35
36
36
## Steps
@@ -45,7 +45,7 @@ This walkthrough contains the following steps:
45
45
46
46
## Connect to CDS
47
47
48
-
Follow the steps below to connect to CDS using the Plug-in Registration tool.
48
+
Follow the steps below to connect to Dataverse using the Plug-in Registration tool.
49
49
50
50
1. Run the Plug-in Registration tool.
51
51
1. Click **Create New Connection**.
@@ -70,7 +70,7 @@ Follow the steps below to register a step for an event on the service endpoint.
70
70
71
71
1. Click **Register New Step**.
72
72
73
-
CDS will now post the current message containing the execution context to the service bus whenever an account is created. The post is performed asynchronously and is not executed immediately.
73
+
Dataverse will now post the current message containing the execution context to the service bus whenever an account is created. The post is performed asynchronously and is not executed immediately.
Copy file name to clipboardExpand all lines: powerapps-docs/developer/common-data-service/webapi/samples/cdswebapiservice-async-parallel-operations.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ The following is required to build and run the CDSWebApiService C# samples :
44
44
45
45
1. Select the **AsyncParallelOperations** project and open the App.config. This is a common [App.config](https://github.com/microsoft/PowerApps-Samples/blob/master/cds/webapi/C%23/CDSWebApiService/App.config) file used by all the samples in this solution. Once you edit this, you can run any of the samples in this solution.
46
46
47
-
1. You must edit the `Url`, `UserPrincipalName`, and `Password` values to set the CDS instance and credentials you want to connect to.
47
+
1. You must edit the `Url`, `UserPrincipalName`, and `Password` values to set the Dataverse instance and credentials you want to connect to.
Copy file name to clipboardExpand all lines: powerapps-docs/developer/common-data-service/webapi/samples/cdswebapiservice-basic-operations.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ The following is required to build and run the CDSWebApiService C# samples :
41
41
42
42
1. Select the **BasicOperations** project and open the App.config. This is a common [App.config](https://github.com/microsoft/PowerApps-Samples/blob/master/cds/webapi/C%23/CDSWebApiService/App.config) file used by all the samples in this solution. Once you edit this, you can run any of the samples in this solution.
43
43
44
-
1. You must edit the `Url`, `UserPrincipalName`, and `Password` values to set the CDS instance and credentials you want to connect to.
44
+
1. You must edit the `Url`, `UserPrincipalName`, and `Password` values to set the Dataverse instance and credentials you want to connect to.
45
45
46
46
```xml
47
47
<addname="Connect"
@@ -250,7 +250,7 @@ namespace PowerApps.Samples
250
250
Console.WriteLine($"Contact URI: {account2Uri}");
251
251
252
252
//Retrieve account, primary contact info, and assigned tasks for contact.
253
-
//CDS only supports querying-by-expansion one level deep, so first query
253
+
//Dataverse only supports querying-by-expansion one level deep, so first query
254
254
// account-primary contact.
255
255
var retrievedAccount2 = svc.Get($"{account2Uri}?$select=name," +
Copy file name to clipboardExpand all lines: powerapps-docs/developer/common-data-service/webapi/samples/cdswebapiservice-parallel-operations.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ More information:
28
28
-[Web API CDSWebApiService class Sample (C#)](cdswebapiservice.md)
29
29
-[Service Protection API Limits](../../api-limits.md)
30
30
31
-
This sample is based on the [How to: Write a simple Parallel.ForEach loop](/dotnet/standard/parallel-programming/how-to-write-a-simple-parallel-foreach-loop) example, but modified to perform create and delete operations with CDS entities using the synchronous methods provided by the CDSWebApiService class.
31
+
This sample is based on the [How to: Write a simple Parallel.ForEach loop](/dotnet/standard/parallel-programming/how-to-write-a-simple-parallel-foreach-loop) example, but modified to perform create and delete operations with Dataverse entities using the synchronous methods provided by the CDSWebApiService class.
32
32
33
33
> [!NOTE]
34
34
> If you want to use Fiddler to observe the expected service protection API limits, you will need to set the number of records to create to be around 10,000. They will start to appear after 5 minutes. Note how the application retries the failures and completes the flow of all the records.
@@ -50,7 +50,7 @@ The following is required to build and run the CDSWebApiService C# samples :
50
50
51
51
1. Select the **ParallelOperations** project and open the App.config. This is a common [App.config](https://github.com/microsoft/PowerApps-Samples/blob/master/cds/webapi/C%23/CDSWebApiService/App.config) file used by all the samples in this solution. Once you edit this, you can run any of the samples in this solution.
52
52
53
-
1. You must edit the `Url`, `UserPrincipalName`, and `Password` values to set the CDS instance and credentials you want to connect to.
53
+
1. You must edit the `Url`, `UserPrincipalName`, and `Password` values to set the Dataverse instance and credentials you want to connect to.
0 commit comments