Mautic Custom Objects Plugin

mikew · May 11, 2022, 1:33pm

Has anyone any experience with this plugin ?

How to install ?

rcheesley · May 11, 2022, 1:35pm

Hi Mike,

We’re currently in a closed beta as there are some relatively complex steps you have to go through to install and work with the plugin until a bunch of PRs are merged into a release.

If you want to join, please ping me on Slack and I can add you to the channel.

jlbs · May 20, 2022, 11:43am

This is the first I’ve seen of this plugin, and it looks amazing! I can see so many potential uses for it.

Best of luck with the development @rcheesley - is there any roadmap for when it might come out of private beta?

rcheesley · May 20, 2022, 11:51am

Thanks to a herculean effort from everybody who has been involved with our Open Source Friday sprints and the Community Sprint a few weeks ago, we managed to get all the dependent PRs merged into the 4.2.1/4.2.2/4.3.0 releases, so we’re aiming for a formal announcement to coincide with the 4.3.0 General Availability release on Monday next week!

It will remain a third party extension which you will have to selectively install like any other plugin, maintained by Acquia but also accepting PRs from the community.

biggala2310 · May 30, 2022, 10:04am

I started using this plugin. At the moment, I have ambivalent feelings. On the one hand we have got more data and possible powerful tool. On the other: adding custom objects in campaigns doesn’t work. Also I can’t find documentantion for connect via API. In the end - we can’t link via forms and use Custom obejcts data dynamic in emails. So - now It is little useless.

rcheesley · May 30, 2022, 10:10am

Please find all the developer documentation in the wiki here: Home · acquia/mc-cs-plugin-custom-objects Wiki · GitHub

biggala2310 · May 30, 2022, 11:21am

Thanks. One more question - linking custom objects to contact in campaign editor doesn’t work only on my instance? I start typing and haven’t any list or something.

Of cource I have got created products and done m:a:g

biggala2310 · June 8, 2022, 12:30pm

@rcheesley @escopecz

Are you planning a feature that allows you link custom objects with contacts via forms? I need this feature and I want to outsource this to our developer. I wonder if you would like to contribute or do this feature will be accepted.

escopecz · June 9, 2022, 10:38am

@biggala2310 I’m glad for this question. We did refactoring of Mautic forms in 2020 to support the Custom Objects plugin in forms. I pushed it here:

github.com/mautic/mautic

Form object refactoring

mautic:5.x ← escopecz:form-object-refactoring

opened 10:36AM - 09 Jun 22 UTC

escopecz

+3155 -997

**Please be sure you are submitting this against the _staging_ branch.** [//]…: # ( Please answer the following questions: ) | Q | A | --- | --- | Bug fix? | N | New feature? | Y | Automated tests included? | Y | Related user documentation PR URL | / | Related developer documentation PR URL | TODO (update the API to not use the deprecated field) | Issues addressed (#s or URLs) | https://forum.mautic.org/t/mautic-custom-objects-plugin/24058/8?u=escopecz | BC breaks? | N | Deprecations? | Y [//]: # ( Note that all new features should have a related user and/or developer documentation PR in their respective repositories. ) [//]: # ( Required: ) #### Description: The final goal is that Custom Objects will be able to inject their objects and fields into the form field mapping form. - [x] Objects and fields must be subscribed by a listener. One event for objects, the other to get all fields for a specific object. - [x] New select box for objects - [x] The fields select box will update its options based on selected object in the previous select box via AJAX. - [x] Create new columns in the form_fields table: mapped_object, mapped_field - [x] In the migration populate the new columns with the value from the lead_field column. Fill in the right object (lead, company) based on the value prefix. - [x] Deprecate the lead_field column in the entity. - [x] Replace usage of deprecated lead_field with mapped_field and mapped_object values. - [x] Replace usages of 'contactFields' and 'companyFields' - [x] Still save the value to the deprecated field for API BC compatibility. - [x] Make sure that if a form is created/modified with the legacy field that it will populate the replacement fields for API BC compatibility. - [x] Store field ~~IDs~~ or aliases? Contains also migration that will create the columns and migrates data from lead_field column. I cleaned the entity a bit too. It was full of verbose syntax, strings over constants and comments that did not bring any value. #### Steps to test this PR: 1. Before you checkout this branch: 2. Create a form with at least 4 fields. One mapped to the contact email field, one mapped to the company field under the contact opt group, one mapped to the primary company city field. The fourth field should not be mapped to any field. 3. Run the migration. Go to the `form_fields` table and check that the last 2 columns are `mapped_object` and `mapped_field`. The field that was mapped to the contact email field should have `mapped_object = 'lead'` and `mapped_field = 'email'`. The one that was mapped to the company field under the contact opt group should have `mapped_object = 'lead'` and `mapped_field = 'company'`. The one that was mapped to the primary company city field should have `mapped_object = 'company'` and `mapped_field = 'companycity'`. The form field that was not mapped at all should have null values there. 4. When you map one field then it should be removed from mapping of other fields. Example: Map contact email field to a form field. Create another field. The contact email field is not in the mapping list. 5. Test submissions of different field types. 6. Test conditional fields 7. Test progressive profiling (behaviours) #### List deprecations along with the new alternative: 1. `form_fields.lead_field` column is deprecated. Use `mapped_object` and `mapped_field` instead. 2. `Mautic\FormBundle\Entity\Field::getLeadField()` and `setLeadField()`. Use getters and setters on `mappedObject` and `mappedField` properties instead. 3. `Mautic\FormBundle\Event\Service\FieldValueTransformer::isIsTransformed()` is deprecated as not used. <a href="https://gitpod.io/#https://github.com/mautic/mautic/pull/11234"><img src="https://gitpod.io/button/open-in-gitpod.svg"/></a>

The priorities shifted and we didn’t finish the implementation in the Custom Objects plugin. But it should make your work way easier. I opened it against the 5.x branch as 4.x won’t have any feature (minor) release.

biggala2310 · July 14, 2022, 11:08am

I talked to my programmer. He will try to complete this task, but we will be joining it after the M5 release to do it with Symfony 5 compatibility.

akshayswiftyweb · November 3, 2022, 5:38am

Hello, biggala2310 did anyone find a solution for this one, I am trying to connect all my old contacts + any new ones as they come, to my custom item. Can anyone help me with this one? Please its urgent.

Topic		Replies	Views
Acquia open sources Custom Objects plugin to extend Mautic’s capabilities Community Blog	0	1441	May 24, 2022
Object migration for plugin mc-cs-plugin-custom-objects 3rd Party Addons	2	392	June 26, 2024
Campaign Action Link to CustomObject - Anyone tried this? Product Support	2	390	February 3, 2023
Experience with custom objects? Product Support	1	403	November 11, 2022
Custom Objects - how to use API with a custom object type "Relationship" 3rd Party Addons development	13	835	July 1, 2024

Mautic Custom Objects Plugin

Related topics