Merge pull request MicrosoftDocs#1668 from MicrosoftDocs/master

Update documentation to reflect background entity creation

Author: JimDaly

powerapps-docs/developer/common-data-service/azure-integration.md

@@ -2,7 +2,7 @@
 title: "Walkthrough: Register an Azure-aware plug-in using the Plug-in Registration Tool (Common Data Service) | Microsoft Docs"
 description: "The walkthrough demonstrates how to register a service endpoint step using the Plug-in Registration Tool. "
 keywords: ""
-ms.date: 10/31/2018
+ms.date: 06/01/2019
 ms.service:
   - powerapps
 ms.custom:
@@ -24,83 +24,71 @@ search.app:
 
 <!-- https://docs.microsoft.com/dynamics365/customer-engagement/developer/walkthrough-register-azure-aware-plug-in-using-plug-in-registration-tool -->
 
-This walkthrough demonstrates how to register a service endpoint step using the Plug-in Registration Tool. Once configured, Dynamics 365 (online) Common Data Service can post the execution context of the current operation to a Azure solution endpoint. For this walkthrough, the step is registered to post the execution context of the <xref:Microsoft.Xrm.Sdk.Messages.CreateRequest> message for an `Account` entity to the Azure Service Bus.  
+This walkthrough demonstrates how to register a service endpoint step using the Plug-in Registration Tool. Once configured, Common Data Service (CDS) can post the execution context of the current operation to a Azure solution endpoint. For this walkthrough, the step is registered to post the execution context of the <xref:Microsoft.Xrm.Sdk.Messages.CreateRequest> message for an `Account` entity to the Azure Service Bus.  
 
- The following prerequisites must be completed before you start this walkthrough:  
+The following prerequisites must be completed before you start this walkthrough:  
 
--   Access to the Plug-in Registration Tool. [!INCLUDE[proc-download-plugin-registration-tool](../../includes/proc-download-plugin-registration-tool.md)]
+- Access to the Plug-in Registration Tool. [!INCLUDE[proc-download-plugin-registration-tool](../../includes/proc-download-plugin-registration-tool.md)]
+- Your CDS system user account must have the System Customizer or System Administrator role. 
+- Have access to a Azure platform service namespace that is configured for SAS authorization, to which CDS will post a message.  
+- 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).  
+- 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).  
 
--   Your Dynamics 365 system user account must have the System Customizer or System Administrator role. 
-  
--   Have access to a Azure platform service namespace that is configured for SAS authorization, to which Dynamics 365 will post a message.  
-  
-  
--   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 Dynamics 365 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).  
-  
--   A configured service endpoint with SAS authorization is available in the target organization. More information: [Walkthrough: Configure Microsoft Azure (SAS) for integration with Dynamics 365](walkthrough-configure-azure-sas-integration.md).  
-  
-## Steps  
- This walkthrough contains the following steps:  
-  
-1.  [Connect to the Dynamics 365 server](#BKMK_Connect)  
-  
-2.  [Register a service endpoint step for an event](#BKMK_Register)  
-  
-3.  [Test the endpoint registration](#BKMK_Test)  
-  
-<a name="BKMK_Connect"></a>   
-## Connect to the Dynamics 365 server  
- Follow the steps below to connect to the Dynamics 365 server using the Plug-in Registration tool.  
-  
-1.  Run the Plug-in Registration tool.  
-  
-2.  Click **Create New Connection**.  
-  
-3.  In the **Login** dialog box, select the deployment type radio button corresponding to the Dynamics 365 server you intend to register a service endpoint with. The **On-premises** radio button includes an IFD deployment and the **Office 365** button is for the Microsoft Online Services provider of Dynamics 365 (online).  
-  
-    |||  
-    |-|-|  
-    |![Login form for an online deployment](media/crm-v6s-pr.png "Login form for an online deployment")<br />Login form for an online deployment|![Login window for an on&#45;premises deployment](media/crm-v6s-pr-login-onprem.png "Login window for an on-premises deployment")<br />Login form for an on-premises deployment|  
-  
-4.  If you check **Display list of available organizations**, you are presented with a list of organizations that you belong to after you click **Login**. This enables you to choose the organization that you want to register the service endpoint with. Otherwise, your default organization is used.  
-  
-5.  Enter the indicated information about the server and login account, and then click **Login**.  
-  
-<a name="BKMK_Register"></a>   
-## Register a service endpoint step for an event  
- Follow the steps below to register a step for an event on the service endpoint.  
-  
-1.  Select an existing service endpoint in the tab of the tab of the target organization.  
-  
-2.  Navigate to the **Register** menu and click **Register New Step**.  
-  
-3.  Fill out the **Register New Step** dialog box for an account create event as shown in the following figure.
+## Steps
 
- ![Creating a service endpoint step](media/crm-v6s-pr-service-endpoint-step.png "Creating a service endpoint step")
+This walkthrough contains the following steps:  
 
-4.  Click **Register New Step**.  
+1. [Connect to CDS](#BKMK_Connect)  
+1. [Register a service endpoint step for an event](#BKMK_Register)  
+1. [Test the endpoint registration](#BKMK_Test)
 
- Dynamics 365 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.  
+<a name="BKMK_Connect"></a>
+
+## Connect to CDS
+ 
+Follow the steps below to connect to CDS using the Plug-in Registration tool.  
 
-<a name="BKMK_Test"></a>   
-## Test the endpoint registration  
- After you register the endpoint you can test it. A listener must be running or a queue available on the target endpoint for the service bus post from the plug-in to happen.  
+1. Run the Plug-in Registration tool.  
+1. Click **Create New Connection**.  
+1. In the **Login** dialog box, select **Office 365**.
+
+    ![Login form for an online deployment](media/crm-v6s-pr.png "Login form for an online deployment")
+
+1. If you check **Display list of available organizations**, you are presented with a list of organizations that you belong to after you click **Login**. This enables you to choose the organization that you want to register the service endpoint with. Otherwise, your default organization is used.  
+1. Enter the indicated information about the server and login account, and then click **Login**.  
 
-1.  Open the Dynamics 365 web application for the same organization that you registered the service endpoint under.  
+<a name="BKMK_Register"></a>
+
+## Register a service endpoint step for an event
+
+Follow the steps below to register a step for an event on the service endpoint.  
 
-2.  Click the **Create** button ![Create button](media/crm-v6s-wa-create-icon.PNG "Create button"), and then click **Account**.  
+1. Select an existing service endpoint in the tab of the tab of the target organization.  
+1. Navigate to the **Register** menu and click **Register New Step**.  
+1. Fill out the **Register New Step** dialog box for an account create event as shown in the following figure.
+
+    ![Creating a service endpoint step](media/crm-v6s-pr-service-endpoint-step.png "Creating a service endpoint step")
 
-3.  Enter an account name, for example `Adventure Works Cycle`, into the **Account Name** field, and then click **Save**.  
+1. Click **Register New Step**.  
 
-4.  Wait about 10 minutes for the Azure Service Bus post to occur.  
+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.  
 
-5.  Click **Settings > System Jobs**.  
+<a name="BKMK_Test"></a>
+
+## Test the endpoint registration
+
+After you register the endpoint you can test it. A listener must be running or a queue available on the target endpoint for the service bus post from the plug-in to happen.  
 
-6.  Open the system job that has the same name that you specified for your service endpoint. Check the status to see if the post was successful, is waiting, or failed.  
+1. Open a canvas or model-driven application for the same organization that you registered the service endpoint under.  
+1. Create a new Account entity record.
+1. Enter an account name, for example 'Adventure Works Cycle', into the **Account Name** field, and then click **Save**.  
+1. Wait about 10 minutes for the Azure Service Bus post to occur.  
+1. In the **Dynamics 365 - Custom** model-driven app, select  **Settings > System > System Jobs**.  
+1. Open the system job that has the same name that you specified for your service endpoint. Check the status to see if the post was successful, is waiting, or failed.  
 
- You can now unregister the endpoint, if so desired, by selecting it in the tool’s tree view and click **Unregister**.  
+You can now unregister the endpoint, if so desired, by selecting it in the tool’s tree view and click **Unregister**.  
 
-### See also  
- [Azure integration for Dynamics 365](azure-integration.md)
- 
- [Introduction to Microsoft Azure Integration with Dynamics 365](azure-integration.md)
+### See also
+
+[Azure integration for CDS](azure-integration.md)<br />
+[Introduction to Microsoft Azure Integration with CDS](azure-integration.md)

powerapps-docs/developer/common-data-service/walkthrough-register-azure-aware-plug-in-using-plug-in-registration-tool.md

@@ -2,7 +2,7 @@
 title: "Work with Dynamics 365 data in your Azure solution (Common Data Service) | Microsoft Docs"
 description: "The ServiceBusPlugin plug-in contains the business logic to post the Dynamics 365 message execution context to the Azure Service Bus. To use this plug-in, you need to register a Azure Service Bus solution endpoint and a step for the plug-in. The step defines what message and entity combination being processed by the core Dynamics 365 operation should trigger the plug-in to execute. The ServiceBusPlugin can only be registered to run asynchronously."
 keywords: ""
-ms.date: 10/31/2018
+ms.date: 06/01/2019
 ms.service:
   - powerapps
 ms.custom:
@@ -22,7 +22,7 @@ search.app:
 
 # Work with Common Data Service data in your Azure solution
 
-An internal plug-in named ServiceBusPlugin is provided with Dynamics 365 (online) Common Data Service. The plug-in contains the business logic to post the Dynamics 365 message execution context to the Azure Service Bus. To use this plug-in, you need to register a Azure Service Bus solution endpoint and a step for the plug-in. The step defines what message and entity combination being processed by the core Dynamics 365 operation should trigger the plug-in to execute. The ServiceBusPlugin can only be registered to run asynchronously. For more information, see [Walkthrough: Register an Azure-aware Plug-in using the Plug-in Registration Tool](walkthrough-register-azure-aware-plug-in-using-plug-in-registration-tool.md).  
+An internal plug-in named `ServiceBusPlugin` is provided with Common Data Service (CDS). The plug-in contains the business logic to post the CDS message execution context to the Azure Service Bus. To use this plug-in, you need to register a Azure Service Bus solution endpoint and a step for the plug-in. The step defines what message and entity combination being processed by the core CDS operation should trigger the plug-in to execute. The `ServiceBusPlugin` can only be registered to run asynchronously. For more information, see [Walkthrough: Register an Azure-aware Plug-in using the Plug-in Registration Tool](walkthrough-register-azure-aware-plug-in-using-plug-in-registration-tool.md).  
 
  In addition, you can write a custom plug-in that includes the required lines of code to post to the service bus. The plug-in is registered in a similar way, except that it must be registered in the sandbox and run under partial trust. For more information on writing a custom plug-in that can post to the Azure Service Bus, see [Write a Custom Azure-aware Plug-in](write-custom-azure-aware-plugin.md).  
 

powerapps-docs/developer/common-data-service/work-data-azure-solution.md

@@ -34,22 +34,36 @@ Sign in to PowerApps at [https://web.powerapps.com](https://web.powerapps.com/?u
 
     Before you create an entity, check out the [entity reference](../../developer/common-data-service/reference/about-entity-reference.md) for a description of available standard entities. These entities cover typical scenarios. If one of these entities meets your requirements as is or after minor changes, you can save time by starting with that entity. 
 
-3. In the **New entity** panel, in the **Display name** box, enter **Product review**, and then optionally enter a description (descriptions are helpful if other people will use this entity). Other fields in the panel are autopopulated, as described below. When you're done, click **Next**.
+3. In the **New entity** panel, do the following:
 
-    * **Plural display name** - This field is autopopulated when you enter a display name, but you can change it if needed. The plural display name is the name of the entity in the Common Data Service WebAPI and is used when interacting with this entity from PowerApps or Flow.
-    * **Name** - This field is also autopopulated when you enter a display name. The prefix was set up when the environment was created and ensures that the entities you create can be exported and imported into other environments without conflicting with other entity names. You can change this prefix by updating the prefix on your Publisher for the Common Data Service Default Solution. To keep existing apps from breaking, you cannot change the name after saving the entity.
+    a. In the **Display name** box, enter **Product review**.
+
+    Observe that the following boxes are autopopulated as you enter a display name:
+
+    * **Plural display name** - This box is autopopulated when you enter a display name, but you can change it if needed. The plural display name is the name of the entity in the Common Data Service WebAPI and is used when interacting with this entity from PowerApps or Flow.
+    * **Name** - This box is also autopopulated when you enter a display name. The prefix was set up when the environment was created and ensures that the entities you create can be exported and imported into other environments without conflicting with other entity names. You can change this prefix by updating the prefix on your Publisher for the Common Data Service Default Solution. To keep existing apps from breaking, you cannot change the name after saving the entity.
 
        > [!NOTE]
        > In order for the entity name to work with [Dynamics 365 for Customer Service embedded knowledge search](/dynamics365/customer-engagement/customer-service/set-up-knowledge-management-embedded-knowledge-search), the maximum entity name length including the publisher prefix can’t exceed 24 characters.
+
+    b. In the **Primary Field** section, in the **Display name** box, replace **Name** with **Product Review**. 
+
+    By default, every entity contains a **Primary Field**, which is used by lookup fields when establishing relationships with other entities. Typically the primary field stores the name or primary description of the data stored in the entity. You may update the name and display name of the primary field before saving the entity for the first time.
+
+    Also, observe that the primary field also has its own **Name** box, which functions similarly to the entity name described above. The primary field name is autopopulated when a display name is entered, uses the same prefix as the entity, and cannot be changed after the entity is created.
+
+    c. Open the **More settings** section and expand the **Description** accordion. You may enter a description for your entity if you wish (descriptions are helpful if other people will use this entity). 
+    
+    d. When you're done, click **Create**.
 
-    ![New Entity](./media/data-platform-cds-create-entity/newentitypanel.png "New entity panel")
+    ![New Entity](./media/data-platform-cds-create-entity/newentitypanel.png "New Entity Panel")
 
-4. On the entity details page, click or tap the **Primary Name** field to open the **Primary Name** panel, and then in the **Display name** box, replace **Primary Name** with **Product Review**. In the **Name** box, replace **PrimaryName** with **ProductReview**, and then click or tap **Done**.
- 
-    By default, every entity contains a Primary Name field, which is used by lookup fields when establishing relationships with other entities. Typically the Primary Name field stores the name or primary description of the data stored in the entity. You may update the name and display name of the Primary Name field before saving the entity for the first time.
+4. On the entity details page, observe that the entity is now being provisioned in the background. Once provisioning is completed, your entity will be saved and available for use in apps. Fields, relationships, and keys can be added to your entity at any time (even while provisioning is still in progress), but views, forms, charts, dashboards, and business rules can only be added to the entity after provisioning is completed.
 
     ![Entity Details](./media/data-platform-cds-create-entity/newentitydetails.png "New Entity Details")
 
+5. Under the **Fields** tab, observe the **Primary Field** that you named in the previous step. Click or tap the **Primary Field** field to open the **Primary Field** panel if you would like to make any additional customizations to the field. Notice that the **Name** can no longer be changed, since the entity has already been saved.
+
 5. To add a field to the entity, do the following:
 
     a. In the command bar, click or tap **Add field** to open the **Field properties** panel.
@@ -78,7 +92,7 @@ Sign in to PowerApps at [https://web.powerapps.com](https://web.powerapps.com/?u
 
     Note that all entities have read-only system fields. By default, system fields are not shown in the list of fields even though they exist in the entity. To see all fields, change the filter on the command bar from **Default** to **All**. For more information on the metadata related to an entity, see [Entity metadata](../../developer/common-data-service/entity-metadata.md).
 
-7. Click **Save entity** to save your entity and make it available for use in apps.
+7. Click **Save Entity** to save the latest changes to your entity.
 
     The Product Review entity should appear in the list of entities in your database. If you don't see it, change the filter in the command bar from **Default** to **Custom**.