Including css and js in orocrm new bundles views

We are writing an orocrm extension providing some new bundles. We would like to add our css and js files (with our styles and functions) to these bundles, but I don’t understand how to do this. Is it possible? How can I do it?
thanks
Alessandra

Topic

[Yevhen ShyshkinParticipant]

Hello, Alessandra.

JS files should be added using requirejs.yml file, here is example. Also you can look and specific implementations to find out how to work with require.js.

CSS files should be added using assets.yml file, here is example.

[alendoParticipant]

Thanks Yevhen,
for js do I need to do something else? because I did as you suggested:

config: paths: 'educaevent/js/change-status-confirmation': 'bundles/educacloudeducaevent/js/change-status-confirmation.js' 'educaevent/js/educaevent': 'bundles/educacloudeducaevent/js/educaevent.js'

1 2 3 4 5 6

config:     paths:         'educaevent/js/change-status-confirmation': 'bundles/educacloudeducaevent/js/change-status-confirmation.js'         'educaevent/js/educaevent': 'bundles/educacloudeducaevent/js/educaevent.js'

but I cannot find js files in header. Is there another app/console command to install these files?
Files are correctly deployed on web side with

php app/console assets:install --symlink web

1 2 3

php app/console assets:install --symlink web

For css, I’m working in dev mode and css works only if I set in config_dev.yml

oro_assetic: css_debug: ~ css_debug_all: true

1 2 3 4 5

oro_assetic:     css_debug:      ~     css_debug_all:  true

it’s correct?

[Yevhen ShyshkinParticipant]

JS:

1) ensure that your js files are really defined under specified path (bundles/educacloudeducaevent/js/change-status-confirmation.js);

2) ensure that your JS “educaevent/js/change-status-confirmation” set in dependencies of some loaded module (i.e. should be executed), because in dev environment requirejs modules loaded on demand in realtime, so you will not see them in header; you can use firebug or any debug tool to check list of loaded files;

3) in prod mode you need to execute oro:requirejs:build to build minified JS that will contain your JS code.

CSS:

1) ensure that your CSS registered in assets.yml really exists under specified path, and then clear cache manually or using cache:clear command;

2) execute assetic:dump command to regenerate all assets including CSS, and don’t forget to clear browser cache.

General recommendations:

oro_assetic.css_debug_all can be used during development, but in production all CSS and JS should be compressed in one file to decrease page loading time.

Also to regenerate all CSS and JS in hard style you can do update, i.e. manually remove cache directories from /app/cache, and then execute oro:platform:update command – it will do all actions described above.

[alendoParticipant]

I’m deploying in prod mode and previous deployed js and css don’t work. I followed these steps:

• I verified that in web/bundles/<mybundle>/js and web/bundles/<mybundle>/css I have my js and css files
• I verified for js that in requirejs.yml I refer the correct path
• I verified for css that in assets.yml I refer the correct path
• I executed in the order:
  
  # app/console cache:clear --env=prod
  # php app/console assets:install --symlink web
  # app/console oro:requirejs:build # to generate oro.min.js
  # app/console assetic:dump --env=prod # to generate 7946a9a.js and oro.css

But I have a different behaviour from dev mode and prod mode (in prod mode js doesn't work). Is there an error in my procedure?
thanks
Alessandra

[Yevhen ShyshkinParticipant]

Hello.

> But I have a different behaviour from dev mode and prod mode (in prod mode js doesn’t work)
What exactly does not work?

To make deployment easier you can manually remove cache and run php app/console oro:platform:update --force --symlink --env prod – this command executes all required operations in the correct order.

[alendoParticipant]

When I execute

php app/console oro:platform:update --force --symlink --env prod but my installers

1 2 3

php app/console oro:platform:update --force --symlink --env prod but my installers

I have this error on a table of my application

[Doctrine\DBAL\Schema\SchemaException] The table with name 'oro_azienda0.educa_vocabulary' already exists.

1 2 3 4

[Doctrine\DBAL\Schema\SchemaException]                                 The table with name 'oro_azienda0.educa_vocabulary' already exists.

I’ve seen that also orocrm installers don’t control if the tables already exist before create them.

[Yevhen ShyshkinParticipant]

> The table with name ‘oro_azienda0.educa_vocabulary’ already exists.
Look’s like you’ve created this table not via installer/migration – that’s why you have this error. Please, check your migrations. Also you can manully update records in oro_migration table if you sure that appropriate migrations already were executes.

> I’ve seen that also orocrm installers don’t control if the tables already exist before create them.
It’s ok – migations must be executed in one specific order, and all executed migrations are shifting version in DB table oro_migration.

[alendoParticipant]

Help! We provided all installers for our entities, but there is none of our entities within the table oro_migration! Like those in the following:

<?php namespace EducaCloud\Bundle\BaseTablesBundle\Migrations\Schema; use Doctrine\DBAL\Schema\Schema; use Oro\Bundle\MigrationBundle\Migration\Installation; use Oro\Bundle\MigrationBundle\Migration\QueryBag; /** * @SuppressWarnings(PHPMD.TooManyMethods) * @SuppressWarnings(PHPMD.ExcessiveClassLength) */ class EducaCloudBaseTablesBundleInstaller implements Installation { /** * {@inheritdoc} */ public function getMigrationVersion() { return 'v1_0'; } /** * {@inheritdoc} */ public function up(Schema $schema, QueryBag $queries) { /** Tables generation **/ $this->createEducaVocabularyTable($schema); $this->createEducaVocabularyTermsTable($schema); $this->createEducacloudEduGoalsTable($schema); $this->createEducacloudProfessionsTable($schema); /** Foreign keys generation **/ $this->addEducaVocabularyTermsForeignKeys($schema); $this->addEducacloudEduGoalsForeignKeys($schema); $this->addEducacloudProfessionsForeignKeys($schema); } ...

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

<?php   namespace EducaCloud\Bundle\BaseTablesBundle\Migrations\Schema;   use Doctrine\DBAL\Schema\Schema; use Oro\Bundle\MigrationBundle\Migration\Installation; use Oro\Bundle\MigrationBundle\Migration\QueryBag;   /** * @SuppressWarnings(PHPMD.TooManyMethods) * @SuppressWarnings(PHPMD.ExcessiveClassLength) */ class EducaCloudBaseTablesBundleInstaller implements Installation {     /**      * {@inheritdoc}      */     public function getMigrationVersion()     {         return 'v1_0';     }       /**      * {@inheritdoc}      */     public function up(Schema $schema, QueryBag $queries)     {         /** Tables generation **/         $this->createEducaVocabularyTable($schema);         $this->createEducaVocabularyTermsTable($schema);         $this->createEducacloudEduGoalsTable($schema);         $this->createEducacloudProfessionsTable($schema);           /** Foreign keys generation **/         $this->addEducaVocabularyTermsForeignKeys($schema);         $this->addEducacloudEduGoalsForeignKeys($schema);         $this->addEducacloudProfessionsForeignKeys($schema);     } ...

We we install from scratch those installation work correctly, but oro doesn’t track them, I suppose.

[Yevhen ShyshkinParticipant]

If you have only installers and don’t have migrations – you can use approach with empty installer used in MailChimp bundle https://github.com/orocrm/OroCRMMailChimpBundle/tree/master/Migrations/Schema.

But still this is an issue and we need to fix it.

[Yevhen ShyshkinParticipant]

That’s odd, but I can’t reproduce this issue. I’ve created bundle AcmeTestBundle with only one installer in Acme/Bundle/TestBundle/Migrations/Schema/AcmeTestBundleInstaller.php similar to yours – and after instllation I have record about this migration in oro_migration table:

bap_dev=# select * from oro_migrations where bundle = 'AcmeTestBundle'; id | bundle | version | loaded_at ----+----------------+---------+--------------------- 9 | AcmeTestBundle | v1_0 | 2015-01-29 12:49:31 (1 row)

1 2 3 4 5

bap_dev=# select * from oro_migrations where bundle = 'AcmeTestBundle'; id |     bundle     | version |      loaded_at       ----+----------------+---------+---------------------   9 | AcmeTestBundle | v1_0    | 2015-01-29 12:49:31 (1 row)

Then I’ve run platform:update and this installer was not executed:

> php app/console oro:platform:update --force --symlink Process migrations... > Oro\Bundle\MigrationBundle\Migration\UpdateBundleVersionMigration > Oro\Bundle\EntityExtendBundle\Migration\RefreshExtendCacheMigration > Oro\Bundle\EntityConfigBundle\Migration\UpdateEntityConfigMigration > Oro\Bundle\EntitySerializedFieldsBundle\Migration\SerializedDataMigration > Oro\Bundle\EntityExtendBundle\Migration\UpdateExtendConfigMigration > Oro\Bundle\ActivityListBundle\Migration\ActivityListMigration > Oro\Bundle\EntityExtendBundle\Migration\UpdateExtendIndicesMigration

1 2 3 4 5 6 7 8 9

> php app/console oro:platform:update --force --symlink Process migrations...   > Oro\Bundle\MigrationBundle\Migration\UpdateBundleVersionMigration   > Oro\Bundle\EntityExtendBundle\Migration\RefreshExtendCacheMigration   > Oro\Bundle\EntityConfigBundle\Migration\UpdateEntityConfigMigration   > Oro\Bundle\EntitySerializedFieldsBundle\Migration\SerializedDataMigration   > Oro\Bundle\EntityExtendBundle\Migration\UpdateExtendConfigMigration   > Oro\Bundle\ActivityListBundle\Migration\ActivityListMigration   > Oro\Bundle\EntityExtendBundle\Migration\UpdateExtendIndicesMigration

I’m using latest master. Could you provide more detailed description about your issue? Maybe you’ve created tables with doctrine:schema:update and then tried to execute platform:update?

[Author]

Replies