Merge pull request #1732 from MicrosoftDocs/master-jdaly-6-20-19

Master jdaly 6 20 19

Author: JimDaly

powerapps-docs/developer/common-data-service/understand-the-data-context.md

@@ -2,7 +2,7 @@
 title: "Understand the execution context (Common Data Service) | Microsoft Docs" 
 description: "Learn about the data that is passed to your plug-ins when it is executed." 
 ms.custom: ""
-ms.date: 05/25/2019
+ms.date: 06/20/2019
 ms.reviewer: pehecke
 ms.service: powerapps
 ms.topic: "article"
@@ -168,11 +168,12 @@ When you define an entity image, you specify an entity alias value you can use t
 var oldAccountName = (string)context.PreEntityImages["a"]["name"];
 ```
 
-More information: [Define entity images](register-plug-in.md#define-entity-images)
+More information:
+
+- [Define entity images](register-plug-in.md#define-entity-images)
+- [Entity Images for workflow extensions](workflow/workflow-extensions.md#entity-images-for-workflow-extensions)
 
-### Entity Images for custom workflow activites
 
-There is no way to configure entity images for custom workflow activities since you only register the assembly and the workflow activity runs in the context of the workflow. For custom workflow activities entity images are available using the key values `PreBusinessEntity` and `PostBusinessEntity` respectively for the pre and post entity images.
 
 ### See also
 

powerapps-docs/developer/common-data-service/workflow/workflow-extensions.md

@@ -2,7 +2,7 @@
 title: "Workflow Extensions (Common Data Service) | Microsoft Docs" # Intent and product brand in a unique string of 43-59 chars including spaces
 description: "You can extend the options available within the designer for workflows. These extensions are added by adding an assembly that contains a class the extends the CodeActivity class. These extensions are commonly called workflow assemblies or workflow activities." # 115-145 characters including spaces. This abstract displays in the search result.
 ms.custom: ""
-ms.date: 06/12/2019
+ms.date: 06/20/2019
 ms.reviewer: "pehecke"
 ms.service: powerapps
 ms.topic: "article"
@@ -400,6 +400,44 @@ If you make changes that include significant changes to public classes or method
 
 When all processes are converted to use the new assembly, you can use the Plug-in Registration tool to Unregister the assembly, so it will no longer be available. More information: [Unregister components](../register-plug-in.md#unregister-components)
 
+## Performance Guidance
+
+Performance considerations for your workflow extensions are the same as for ordinary plug-ins.  More information: [Performance considerations](../write-plug-in.md#performance-considerations)
+
+Unlike an ordinary plug-in, with workflow extensions you do not have the opportunity to explicitly register your code for a specific step. This means you don't control whether the code in your workflow extension will run synchronously or asynchronously. Particular care must be considered for code that runs synchronously because it will directly impact the application user's experience.
+
+As re-usable components, workflow extensions can be added to any workflow or custom action. The workflow may be configured as a *real-time* workflow, which means it will run synchronously. Custom actions are always synchronous, but they do not participate in a transaction unless they have **Enable rollback** set.
+
+> [!IMPORTANT]
+> When your workflow extension is used in a synchronous workflow or a custom action the time spent running the code directly impacts the user's experience. For this reason, workflow extensions should require no more than two seconds to complete when used synchronously. If your extension requires more time than this, you should document this and discourage use of the extension in synchronous workflows or custom actions.
+
+You should also be aware that in a synchronous workflow or a custom action that that participates in the transaction, any error thrown by your workflow extension will cause the entire transaction to rollback, which is a very expensive operation that can impact performance.
+
+You can use the value in the <xref:Microsoft.Xrm.Sdk.Workflow.IWorkflowContext>.<xref:Microsoft.Xrm.Sdk.Workflow.IWorkflowContext.WorkflowMode> property to determine if the plug-in is running synchronously.
+
+## Real-time workflow stages
+
+When a workflow extension is used in a real-time (synchronous) workflow it will be invoked in the event execution pipeline stages shown in the following table. For more information : [Event execution pipeline](../event-framework.md#event-execution-pipeline)
+
+|Message  |Stage  |
+|---------|---------|
+|**Create**|PostOperation|
+|**Delete**|PreOperation|
+|**Update**|PreOperation or <br /> PostOperation|
+
+You can use the value in the <xref:Microsoft.Xrm.Sdk.Workflow.IWorkflowContext>.<xref:Microsoft.Xrm.Sdk.Workflow.IWorkflowContext.StageName> property to detect the stage.
+
+For the **Update** operation, the stage is configurable using **Before** or **After** options in the workflow designer. More information: [Using real-time workflows](/flow/configure-workflow-steps#using-real-time-workflows)
+
+If your workflow extension depends on data passed in the execution context, the stage it runs in will control whether data is available in the <xref:Microsoft.Xrm.Sdk.Workflow.IWorkflowContext>.<xref:Microsoft.Xrm.Sdk.IExecutionContext.InputParameters> and <xref:Microsoft.Xrm.Sdk.Workflow.IWorkflowContext>.<xref:Microsoft.Xrm.Sdk.IExecutionContext.OutputParameters>.
+
+> [!NOTE]
+> We don't recommend including logic dependencies based on the <xref:Microsoft.Xrm.Sdk.IExecutionContext.InputParameters> and <xref:Microsoft.Xrm.Sdk.IExecutionContext.OutputParameters>. Workflow extensions should depend on the configured [input and output parameters](#input-and-output-parameters) so that the person using the workflow extension can understand the expected behavior without having anything hidden from them.
+
+## Entity Images for workflow extensions
+
+There is no way to configure entity images for workflow extensions since you only register the assembly and the workflow activity runs in the context of the workflow. For  workflow extensions entity images are available using the key values `PreBusinessEntity` and `PostBusinessEntity` respectively for the pre and post entity images. More information: [Entity Images](../understand-the-data-context.md#entity-images)
+
 
 ### See also
 

powerapps-docs/developer/common-data-service/write-plug-in.md

@@ -2,7 +2,7 @@
 title: "Write a plug-in (Common Data Service) | Microsoft Docs" # Intent and product brand in a unique string of 43-59 chars including spaces
 description: "Learn about the concepts and technical details necessary when writing plug-ins" # 115-145 characters including spaces. This abstract displays in the search result.
 ms.custom: ""
-ms.date: 05/26/2019
+ms.date: 06/20/2019
 ms.reviewer: ""
 ms.service: powerapps
 ms.topic: "article"
@@ -155,7 +155,10 @@ More information: [Use Tracing](debug-plug-in.md#use-tracing), [Logging and trac
 
 ## Performance considerations
 
-When you add the business logic for your plug-in you need to be very aware of the impact they will have on overall performance. The business logic in plug-ins should take no more than 2 seconds to complete.
+When you add the business logic for your plug-in you need to be very aware of the impact they will have on overall performance.
+
+> [!IMPORTANT]
+> The business logic in plug-ins registered for synchronous steps should take no more than 2 seconds to complete.
 
 ### Time and resource constraints