entityeventlistener | Community Creatio

Question

Mariam Moufaddal

13:16 Dec 08, 2022

Hello,

I am willing to add a process for validation on Save for the Case object as shown in figure attached.

Any insights please?

Thanks,

1 comments

Kalymbet Anastasia

20:28 Dec 12, 2022

Hello,

The following instructions can help you to achieve the result you are looking for: validators schema section

Show all comments

Question

Asynchronous

BaseEntityEventListener

entityeventlistener

7.18

Entity Event Listener Async

User1997

16:19 Feb 01, 2022

I am using the BaseEntityEventListener.OnSaving method where in addition to saving the entity I want to call an asynchronous method. Is there any way I can convert OnSaving to asynchronous?

1 comments

Bogdan

16:57 Feb 01, 2022

Hello,

Unfortunately, it could be achieved only via Asynchronous operations in the Entity event layer described by the link below:
https://academy.creatio.com/docs/developer/back_end_development/objects…

Best regards,

Bogdan

Show all comments

Question

entityeventlistener

ValidationMessage

Studio_Creatio_enterprise_edition

7.18

Add validation message in Entity Events layer

Shivani Lakshman

08:40 Dec 10, 2021

Hello,

I am trying to validate a record before it gets inserted into the DB using entity events layer : public override void OnInserting(object sender, EntityBeforeEventArgs e);

If the validation fails, I would like to display a message to the user. Is there a built in method like set validation message or something? I understand this can be done through Web socket but I would prefer if I am able to use a built in validator.

Thanks

2 comments

Best reply

Ryan Farley

18:09 Dec 10, 2021

Hello Shivani,

You can simply throw an exception from the event and it will halt the insert process and display the exception message to the user.

An an example, this OnInserting event checks to ensure the Also known as field is not empty:

using System;
using Terrasoft.Core.Entities;
using Terrasoft.Core.Entities.Events;
 
namespace FX.EntityEventListeners
{
    [EntityEventListener(SchemaName = "Account")]
    public class UsrAccountEntityEvents : BaseEntityEventListener
    {
        public override void OnInserting(object sender, EntityBeforeEventArgs e)
        {
            base.OnInserting(sender, e);
            var account = (Entity)sender;
 
            if (string.IsNullOrEmpty(account.GetTypedColumnValue&lt;string&gt;("AlternativeName"))) 
            {
                throw new Exception("Also known as cannot be blank");
            }
        }
    }
}

This displays this message when the user inserts an account without this field populated:

Ryan

Ryan Farley

18:09 Dec 10, 2021

Hello Shivani,

You can simply throw an exception from the event and it will halt the insert process and display the exception message to the user.

An an example, this OnInserting event checks to ensure the Also known as field is not empty:

using System;
using Terrasoft.Core.Entities;
using Terrasoft.Core.Entities.Events;
 
namespace FX.EntityEventListeners
{
    [EntityEventListener(SchemaName = "Account")]
    public class UsrAccountEntityEvents : BaseEntityEventListener
    {
        public override void OnInserting(object sender, EntityBeforeEventArgs e)
        {
            base.OnInserting(sender, e);
            var account = (Entity)sender;
 
            if (string.IsNullOrEmpty(account.GetTypedColumnValue&lt;string&gt;("AlternativeName"))) 
            {
                throw new Exception("Also known as cannot be blank");
            }
        }
    }
}

This displays this message when the user inserts an account without this field populated:

Ryan

Shivani Lakshman

12:46 Dec 15, 2021

Thanks Ryan! This works!

Show all comments

Question

Do package installations trigger entity events?

M Shrikanth

11:28 Apr 23, 2021

Hello Community,

Lets say, I have a Business process which is triggered when an Email Template record is modified, and that Email template is updated via a Package installation, the logical expectation is that the 'Modified' event is triggered and the Business process runs. We however notice that the event is not triggered, and the business process does not run.

Do Package installations and changes through that trigger entity events? Do Package installations effect object changes to the DB via the ORM or does that mechanism work differently?
If I wrote a business process which had a trigger to the SysPackage object and looked for modifications to a specific package, will it get triggered when I install that package??

2 comments

Anastasiia Zhuravel

15:47 Apr 23, 2021

Hello,

Our application doesn't support designing business processes that are triggered after modifying system objects. The core of business process mechanisms works on low-level API which doesn't support start signals functionality. This is done in order to avoid any kind of accidents with business process mechanisms and also for performance maintaining reasons.

Best regards,

Anastasiia

M Shrikanth

16:43 Apr 23, 2021

Anastasiia Zhuravel, Thanks Anastasiia,

I am not sure I understood this - "The core of business process mechanisms works on low-level API which doesn't support start signals functionality". Are you saying that the start signal functionality does not work in Business processes?

Show all comments

Question

entityeventlistener

objects

7.16

Entity event layer - System & custom schemas

M Shrikanth

20:20 Sep 16, 2020

Hello Community,

The Entity event layer is a powerful tool to listen to changes to schemas on the server side and perform actions based on them. The documentation states the following -

The Entity event layer mechanism is triggered after executing the event subprocesses of an object.

Few questions below -

Are entity events triggered for all system schemas & custom schemas? We know it works with Custom schemas, but we have had a few instances where it did not get triggered for system schemas Eg 'System administration object' or 'Image' object. We also notice that a business process with Start signal tied to the "System administration object" or 'Image" object also doesn't work.
Are there any restrictions around which schemas/objects or kinds of changes, these entity events will get triggered for?
Are the entity layer events triggered on the server exactly the same as the 'Signal' start events that we configure in the Business process designer?

5 comments

Best reply

Angela Reyes

13:35 Sep 17, 2020

Dear Shrikanth,

1. It is triggered for all entity objects present in the configuration section.

2. It gets triggered by any CRUD operations performed using DataServevice (Entity and EntitySchemaQuery), OData, and OOTB business process elements. It will not get triggered if data is changed using Insert, Update, Delete classes, and if data is changed directly on the DB level.

3. It works the same as the Event subprocess https://academy.creatio.com/documents/technic-bpms/7-16/event-sub-process-element

Best regards,

Angela

Angela Reyes

13:35 Sep 17, 2020

Dear Shrikanth,

1. It is triggered for all entity objects present in the configuration section.

3. It works the same as the Event subprocess https://academy.creatio.com/documents/technic-bpms/7-16/event-sub-process-element

Best regards,

Angela

M Shrikanth

14:26 Sep 17, 2020

Angela Reyes,

Thank you Angela for your clear responses.

I am presuming that there are no special settings to be done to enabled for them to be triggered on System objects. Hence, our errors are not the expected behavior is what I understand.

M Shrikanth

09:39 Sep 18, 2020

Angela Reyes,

Hi Angela. Quick follow up question -

1. Do entity events get triggered for virtual objects & views as well? Virtual objects are also objects displayed in Configuration. So going by your explanation, It should. Can you confirm?

2. Are entity events listenable on the Client side? I do not think so. Can you confirm?

Angela Reyes

00:34 Sep 22, 2020

M Shrikanth,

1) I have not checked it - try to create a test process and check it.

2) If you set up sending of an event it can be done.

Best regards,

Angela