Extension Points Reference
This page serves as a central hub for exploring the DEE Extension Points usually referred to as DEE Action Groups.
DEE extension points are hooks in the CM MES Backend logic to which you may attach Dynamic Execution Engine (DEE) Actions in runtime.
You can look at DEE Actions as soft rules defined in C# code which are loaded, compiled and executed by the MES Backend during runtime. The most common use for DEE Actions is to implement pre and post-transaction logic.
Catalog
The DEE Extension Points Catalog is available on the left menu of this page, grouped by namespace suffix - or browse it here:
Flow
A MES Extension Point executes the following flow:
- Evaluates and executes DEE Actions associated with the DEE Action Group
PRE; - Executes the standard method flow;
- Evaluates and executes DEE Actions associated with the DEE Action Group
POST; - Returns the method output parameters.
Warning
Do not forget that:
- DEE Actions executed on PRE/POST may change values of the input/output parameters, which may affect "standard method flow";
- DEE execution order is not ensured if multiple DEEs are associated with the same endpoint and the same execution priority;
- DEE execution order may affect results obtained for equivalent requests.
Naming Convention
The DEE Extension Points have the following name convention:
{NamespaceSuffix}.{ClassName}.{MethodName}
So if the following method has a DEE Extension Point:
- .NET namespace:
Cmf.Navigo.BusinessObjects; - Class name:
Regards; - Method name:
GetAll;
then the extension point name will be BusinessObjects.Regards.GetAll.
Warning
Due to retro-compatibility in some cases, this naming convention may not be followed in its entirety.
Hints
Resolve DEE Action Groups using REST API
To discover the Extension Point you need to use to customize a MES functionality, use the following strategy:
- Search for the CM MES REST API endpoint where the functionality is implemented;
- Convert the REST API endpoint into DEE Extension Points name;
- Locate the service controller endpoint in the DEE Extension Points catalogue;
- Use the DEE Extension Point page
InvokeandInvoked Bysections, to discover:- The various DEE Extension Points executed during the service call;
- Understand the impact of your changes;
- Select the proper Extension Point in the call stack to attach the new behavior.
To use the REST API endpoint URL to discover the DEE Extension Point, taking into consideration that the CM MES REST API endpoints have the following URL convention:
https://{mes_ui_url}/api/{service_name}/{operation_name}
- {service_name} - Corresponds to the extension point class name without the suffix 'Controller';
- {operation_name} - Corresponds to the method name inside the class.
As an example, considering that your REST API endpoint is https://{mes_ui_url}/api/UIPage/GetPinnedDashboards, then we know that:
- The MES Backend code entry point is a class with the name
UIPageControllerand the methodGetPinnedDashboards; - The name of the first extension point executed ends with
UIPageController.GetPinnedDashboards.
Using this information and this website search, you may easily find both the class and the Extension Point documentation pages.
Resolve DEE Action Groups using Host API documentation
If a Host API method supports a DEE extension, its documentation will include an entry in the "Remarks" section with a link to the corresponding DEE Action Group documentation.