Plugin Self Registration 1: The Concept

Tools like spkl do a great job at registering plugins. But did you ever have to turn down an idea due to the reasoning “I can’t determine on which entities this would need to run when I implement this”? While most of the time you can determine quite well at the design time which entities and fields need to be part of the trigger, sometimes, especially in very generic or configured logic you run into the problem of design time registrations.

Unfavorable requirements

Let’s take a look at some requirements that are problematic: “We need to export all changes to certain entities in a specific format, we want to configure the entities and fields on the fly because we can’t determine a complete list now.”
“We have a specific pattern of how to build the primary fields for our custom entities, implement that pattern for us so our admin can apply it to the new entities.”

If you had a generic logic that can run on any entity of course you could just deliver the plugin to the production and then tell the key user/admin/whomever to use the plugin registration tool to add a step to your plugin type, but lets be honest here, the audience for that is quite small. Something like a configuration entity would be beneficial for those scenarios. Even a key user would know the entity and field name to create a record in CRM, but creating a plugin step is a whole different story.

And if we think about highly configurable logic that you might want to release to multiple customers as an ISV solution: It becomes unfeasible to train them on the Plugin Registration Tool and at the same time it is impossible to preconfigure the solution in development because you don’t have the customers custom entities and fields to register to.

The idea

So for this problem, let me pose an idea to you: What if we just create a regular entity for configuring your logic? Then we create a plugin reacting to changes in your configuration entity and that will handle the registration of a plugin step for the real logic based on what someone just did at the configuration entity. Of course we will then always have two plugins, one with the actual logic and one that will make sure that the logic is triggered at the right moment.

To come up with a more visual representation of this idea: “Let’s transform a configuration entity into a spkl-CrmPluginRegistration at runtime”.

The problem

That sounds quite simple actually, but the devil lies in the detail: For registering a plugin step you will need to interface the following entities: sdkmessage sdkmessagefilter plugintype (serviceendpoint) sdkmessageprocessingstep sdkmessageprocessingstepimage (sdkmessageprocessingstepsecureconfig)

What’s next

That’s quite something, right? On top of that you cannot create relationships from or to these entities, so you cannot simply link your configuration and will have to somehow keep the connection to your sdkmessageprocessingstep as well. But fear not and stay tuned for the next post in this series where I will show you some help to simplify the process to only managing one regular entity so that you can focus on translating your configuration entity into a plugin step!

This site is owned by Marius Wodtke. All rights reserved. Legal notice.
Built with Hugo. Theme Stack designed by Jimmy modified by Marius for GDPR conformity.