Migration – Add column in Oro entity (not work)

Hi guys

I need to add a new column in oro entity (PaymentTerm) and to write the following migration.

PHP

public function up(Schema $schema, QueryBag $queries) { $table = $schema->getTable('oro_payment_term'); if (!$table->hasColumn('erp_formap')) { $table->addColumn( 'erp_formap', 'string', [ 'label' => 'summa.erp_formap.label.label', 'oro_options' => [ 'extend' => ['owner' => ExtendScope::OWNER_CUSTOM, 'origin' => ExtendScope::ORIGIN_CUSTOM, 'is_extend' => true], 'datagrid' => ['is_visible' => DatagridScope::IS_VISIBLE_TRUE], 'merge' => ['display' => true], 'form' => [ 'is_enabled' => true, 'type' => TextType::class ] ] ] ); } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

public function up(Schema $schema, QueryBag $queries)     {         $table = $schema->getTable('oro_payment_term');           if (!$table->hasColumn('erp_formap')) {             $table->addColumn(                 'erp_formap',                 'string',                 [                     'label' => 'summa.erp_formap.label.label',                     'oro_options' => [                         'extend'    => ['owner' => ExtendScope::OWNER_CUSTOM, 'origin' => ExtendScope::ORIGIN_CUSTOM, 'is_extend' => true],                         'datagrid'  => ['is_visible' => DatagridScope::IS_VISIBLE_TRUE],                         'merge'     => ['display' => true],                         'form'      => [                             'is_enabled' => true,                             'type'       => TextType::class                         ]                     ]                 ]             );         }     }

Run the migration and add the new column.

PHP

mysql> SELECT * FROM makropaper_db.oro_payment_term; +----+-------------------------+-----------------+------------+ | id | label | serialized_data | erp_formap | +----+-------------------------+-----------------+------------+ | 1 | Habitual | Tjs= | NULL | | 2 | Contrareembolso | Tjs= | NULL | +----+-------------------------+-----------------+------------+

1 2 3 4 5 6 7

mysql> SELECT * FROM makropaper_db.oro_payment_term; +----+-------------------------+-----------------+------------+ | id | label                   | serialized_data | erp_formap | +----+-------------------------+-----------------+------------+ |  1 | Habitual                | Tjs=            | NULL       | |  2 | Contrareembolso         | Tjs=            | NULL       | +----+-------------------------+-----------------+------------+

But…

In the edit view mode, I can’t see the column that I just added. Also doesn’t add to the form of the entity on wherever of the views: create/edit/show.

I’m using the oro_options for this purpose, but I don’t know if I’m using it correctly or not, because I don’t know what are all the possible options for oro_options settings and I didn’t find documentation of that.

Could you help me guys in this?

Thanks!

Topic

[Andrey YatsenkoModerator]

Hi Santiago,

This options, unfortunately, are not fully documented. For now, I could advise you to look into the vendors’ code for examples.

Also, there is a helpful command to check the oro_options values for the field.

Shell

bin/console oro:entity-config:debug "Oro\Bundle\PaymentTermBundle\Entity\PaymentTerm" label

1	bin/console oro:entity-config:debug "Oro\Bundle\PaymentTermBundle\Entity\PaymentTerm" label

Where the label is the field name.

There you can see the full list of supported options and what values were applied after running the migration to make sure they work as expected.

Sometimes options like[view][is_displayable] or [form][is_enabled] can not work as expected, because it requires some extra work on a template, developers could miss it so you have to override the template first, by getting an example from the place where it works.

[Santiago PalaciosParticipant]

Thanks Andrey

I’m going to try what you recommend.

[peeushParticipant]

Hi Andrey

I am having the same issue – my custom fields, created programmatically on Customer (and other entities) are not showing anywhere on the application forms despite setting ExtendScope::OWNER_CUSTOM. Below are the oro option values for one such field:

PHP

sudo php bin/console oro:entity-config:debug "Oro\Bundle\CustomerBundle\Entity\Customer" company_reg_no Class: Oro\Bundle\CustomerBundle\Entity\Customer Field: company_reg_no Type: string Mode: default Values: Array ( [extend] => Array ( [owner] => ExtendScope::OWNER_CUSTOM [state] => Active [is_extend] => true [length] => 255 [is_deleted] => false [origin] => System [is_serialized] => false [unique] => false ) [entity] => Array ( [is_total] => false [is_total_currency] => false [label] => oro.customer.company_reg_no.label [description] => oro.customer.company_reg_no.description ) [email] => Array ( [available_in_template] => true ) [datagrid] => Array ( [is_visible] => DatagridScope::IS_VISIBLE_TRUE ) [form] => Array ( [is_enabled] => true ) [view] => Array ( [is_displayable] => true ) [attribute] => Array ( [is_attribute] => true [is_system] => false [searchable] => true [filterable] => true [filter_by] => exact_value [sortable] => true [enabled] => true [visible] => true ) [importexport] => Array ( [excluded] => false ) [dataaudit] => Array ( [auditable] => true ) [merge] => Array ( [autoescape] => true [display] => true ) [sharding] => Array ( [discrimination_field] => false ) )

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

sudo php bin/console oro:entity-config:debug "Oro\Bundle\CustomerBundle\Entity\Customer" company_reg_no Class: Oro\Bundle\CustomerBundle\Entity\Customer Field: company_reg_no Type:  string Mode:  default Values: Array (     [extend] => Array         (             [owner] => ExtendScope::OWNER_CUSTOM             [state] => Active             [is_extend] => true             [length] => 255             [is_deleted] => false             [origin] => System             [is_serialized] => false             [unique] => false         )       [entity] => Array         (             [is_total] => false             [is_total_currency] => false             [label] => oro.customer.company_reg_no.label             [description] => oro.customer.company_reg_no.description         )       [email] => Array         (             [available_in_template] => true         )       [datagrid] => Array         (             [is_visible] => DatagridScope::IS_VISIBLE_TRUE         )       [form] => Array         (             [is_enabled] => true         )       [view] => Array         (             [is_displayable] => true         )       [attribute] => Array         (             [is_attribute] => true             [is_system] => false             [searchable] => true             [filterable] => true             [filter_by] => exact_value             [sortable] => true             [enabled] => true             [visible] => true         )       [importexport] => Array         (             [excluded] => false         )       [dataaudit] => Array         (             [auditable] => true         )       [merge] => Array         (             [autoescape] => true             [display] => true         )       [sharding] => Array         (             [discrimination_field] => false         )   )

What else do I need to do on the templates side etc. to make this field visible on Customer entity forms (CRUD, datagrid)?

Thanks

[peeushParticipant]

Hello – figured out that I also had to override update.html.twig and view-html.twig for OroCustomerBundle:Customer entity to get my custom fields to display on the application forms.

Since file location for overriding templates has changed in symfony 3.4 (and onwards), I had to put my updated twig files in templates/bundles/OroCustomerBundle/Customer instead of <my bundle>Resources/OroCustomerBundle/Customer (or <my bundle>/Resources/views/Customer/

I am now struggling with the code that I need to put in update.html.twig – below is what I have done:

PHP

{% extends '@!OroCustomer/Customer/update.html.twig' %} {% block content_data %} {% set customData = [ form_row(form.company_reg_no) ] %} {% set dataBlocks = [{ 'title': 'Company Details'|trans, 'subblocks': [{ 'title': '', 'useSpan': false, 'data' : customData }] }] %} {% set data = { 'formErrors': form_errors(form), 'dataBlocks': dataBlocks }%} {{ parent() }} {% endblock content_data %}

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

{% extends '@!OroCustomer/Customer/update.html.twig' %}   {% block content_data %}       {% set customData = [         form_row(form.company_reg_no)     ] %}     {% set dataBlocks = [{         'title': 'Company Details'|trans,         'subblocks': [{             'title': '',             'useSpan': false,             'data' : customData         }]     }]  %}       {% set data = {         'formErrors': form_errors(form),         'dataBlocks': dataBlocks     }%}       {{ parent() }} {% endblock content_data %}

My custom field is still not showing up – can you please point me to what did I miss?

Thanks

[Andrey YatsenkoModerator]

There is no need to override the view and update templates completely. Instead, it is recommended to use scroll data events
https://github.com/oroinc/platform/blob/master/src/Oro/Bundle/UIBundle/Resources/doc/reference/scroll-data-customization.md

[Andrey YatsenkoModerator]

But if you still want to override the template, you should place it to src/Resources folder.
https://oroinc.com/orocrm/doc/current/dev-guide/customization#overriding-templates

[peeushParticipant]

Thanks Andrey – will check out scroll data events to add the new fields to the form.

On location of the files for overriding templates – my install is using satis.oroinc.com for OroCommerce code:

PHP

composer create-project oro/commerce-crm-application oroapp --repository=https://satis.oroinc.com

1	composer create-project oro/commerce-crm-application oroapp --repository=https://satis.oroinc.com

I am assuming that means I am on the latest development branch (version 4 or higher) and not the latest stable branch (3.1.11).

I tried both the options noted in the article (copying to src/Resources and overriding the bundle) but neither worked as my install is on Symfony 4.2+ and the referenced article is for OroCommerce v3 (which I believe is on Symfony 3.4).

Am I using the right/recommended file location for overriding templates?

Thanks

[Author]

Replies