Skip to main content

Notifications

Announcements

No record found.

News and Announcements icon
Dynamics 365 Community / Forums / Microsoft Dynamics CRM forum / Is there a Plugin Desi...
Microsoft Dynamics CRM forum
Suggested answer

Is there a Plugin Design Convention ?

(0) ShareShare
ReportReport
Posted on by ErickTreeTops 20

So I have my first plugin working (yeah me). 

I've included both the "Create"  and "Update" logic for an Entity in the same class.

This got me thinking.  How to design a plugin.

Should you only create one plugin per entity and use code in the execute method to determine if the call is a PreValidation or Postvalidation and then test for the message type "Create", "update" etc.

Then branch off to methods\ non plugin classes that cater for each combination of options.

Here you know where the first call will be for every occurrence.

Or,  should you breakdown the plugins for each entity into Post and pre validation and then the message type.  eg.

PersonPreCreate.cs  PersonPreUpdate.cs

is there a best practice ?

The answer , "it depends on the situation" could be true. 

But for large organisations with multiple developer groups, commonality of design would help with learning curves, so would take preference over individual style.

Categories:
Development / Customization / SDK
  • Michel Gueli Profile Picture
    Michel Gueli 982 on at
    RE: Is there a Plugin Design Convention ?

    This is not true. It depends on where you put your logic. My logic is always outside of the plugin classes. That makes it reusable.

  • Michel Gueli Profile Picture
    Michel Gueli 982 on at
    RE: Is there a Plugin Design Convention ?

    Some Tips:

    -Seperate plugin logic from the actual plugin classes, which implement IPLUGIN. Much easier to test.

    -I have a plugin class for each step I use. Folder for each entity. Example incident Folder. 

    --PreOperationIncidentCreate.cs

    --PostOperationIncidentCreate.cs

    --PreOperationIncidentUpdate.cs

    --PostOperationIncidentClose

    -Update same entity where plugin is running on? Yes --> ? PreOperation, No --> PostOperation

    -Custom Security checks --> PreOperation

  • Suggested answer
    Bipin D365 Profile Picture
    Bipin D365 28,962 Moderator on at
    RE: Is there a Plugin Design Convention ?

    Hi,

    If you would like to know the best practices to be followed when designing the plugin then please have a look at below docs page -

    docs.microsoft.com/.../

    Now coming to your question on number of classes for plugin-

    It depends on the requirement, ideally we should have one plugin class per file and then check appropriate message and stage in your code to execute your business logic. However there are some exceptions where you will have to create multiple class file. For instance on same the stage you want to have multple logic to be executed in an order.

    Execution Order -1 Execute some code on Post Update,

    Execution Order - 2 Execute some code on Post update,

    In this case you will need to create two separate plugin class.

    Please mark my answer verified if this is helpful!

    Regards,

    Bipin Kumar

    Follow my Blog: xrmdynamicscrm.wordpress.com/

  • Suggested answer
    Guido Preite Profile Picture
    Guido Preite 54,063 Moderator on at
    RE: Is there a Plugin Design Convention ?

    as you wrote: "it depends on the situation"

Under review

Thank you for your reply! To ensure a great experience for everyone, your content is awaiting approval by our Community Managers. Please check back later.

Helpful resources

Quick Links

Anton Venter – Community Spotlight

Kudos to our October Community Star of the month!

Announcing Our 2024 Season 2 Super Users!

A new season of Super Users has arrived, and we are so grateful for the daily…

Dynamics 365 Community Newsletter - September 2024

Check out the latest community news

more Community News

Leaderboard

#1
André Arnaud de Calavon Profile Picture

André Arnaud de Cal... 290,532 Super User 2024 Season 2

#2
Martin Dráb Profile Picture

Martin Dráb 228,501 Most Valuable Professional

#3
nmaenpaa Profile Picture

nmaenpaa 101,148

Leaderboard

Featured topics

Product updates

Dynamics 365 release plans