Widget is not showing

[youssefaoun]

Hello,

I built a new module based on Example_Module which is nice widget example.

I copied the files of this module and the WIDGET IS NOT SHOWING AT ALL. here are my files:

in Manifest:

 'layoutdefs'=> array(
        array(
            'from'=> '<basepath>/layoutdefs/cases_layout_defs.php', 
            'to_module'=> 'Cases',
        ),
    ), 
  

in cases_layout_defs.php :

 $layout_defs['Cases']['subpanel_setup']['myModule'] = array(
    'order' => 29,
    'module' => 'myModule',
    'subpanel_name' => 'default',    //this is the name of the file
    'get_subpanel_data' => 'myModule',
    'add_subpanel_data' => 'myModule_id',
    'title_key' => 'LBL_MYMODULE_SUBPANEL_TITLE',
    'top_buttons' => array(
        array('widget_class' => 'SubPanelTopSelectButton'),
    ),
); 
  

and 'subpanel_name' => 'default' is really the name of the file under modules/myModule/supanels/default.php

COUld you please help?

regards,

[anna]

Did you also create a cases_vardefs.php file?

Whatever you reference in the layout_defs under get_subpanel_data and the subpanel_setup must exist in the vardefs as a field of type => link. If your relationship is many-to-many, you also need to create a metadata file.

Eg to place a subpanel of module 'Creditcards' under the module of 'Contacts' you would need to have the following:

contacts_vardefs.php

 // should be Contact, not Contacts
$dictionary['Contact']['fields']['creditcards'] =   array (
    'name' => 'creditcards',
    'type' => 'link',
    'relationship' => 'contact_creditcards',
    'source' => 'non-db',
    'vname' => 'LBL_CREDITCARDS'
);
$dictionary['Contact']['relationships']['contact_creditcards'] =   array (
            'lhs_module'=> 'Contacts',
            'lhs_table'=> 'contacts',
            'lhs_key' => 'id',
            'rhs_module'=> 'Creditcards',
            'rhs_table'=> 'creditcards',
            'rhs_key' => 'contact_id',
            'relationship_type'=>'one-to-many'
); 
  

contacts_layoudefs.php

 // should be Contacts, not Contact
$layout_defs['Contacts']['subpanel_setup']['creditcards'] =  array(
            'order' => 140,
            'module' => 'Creditcards',
            'sort_order' => '',
            'sort_by' => '',
            'subpanel_name' => 'default',
        'get_subpanel_data' => 'creditcards',
        'add_subpanel_data' => 'creditcard_id',
        'title_key' => 'LBL_CREDITCARDS_SUBPANEL',
); 
  

Make sure to rebuild the extensions and relationships under Admin if you simply copy the files and don't use ModuleInstaller.
Hope this helps

[youssefaoun]

Thank you for answering

Here is my cases_layout_def.php

 $layout_defs['Cases']['subpanel_setup']['aleksDebugModWidget'] = array(
    'order' => 150,
    'module' => 'aleksDebugModWidget',
    'subpanel_name' => 'default',    //this is the name of the file
    'get_subpanel_data' => 'aleksDebugModWidget',
    'add_subpanel_data' => 'aleksDebugModWidget_id',
    'title_key' => 'LBL_ALEKSDEBUGMODWIDGET_SUBPANEL_TITLE',
    'top_buttons' => array(array('widget_class' => 'SubPanelTopSelectButton'),),
); 
  

Here is cases_vardefs.php

 $dictionary['Case']['fields']['aleksDebugModWidget'] = array (
    'name' => 'aleksDebugModWidget',
    'type' => 'link',
    'relationship' => 'cases_aleksDebugModWidget',
    'vname' => 'LBL_ALEKSDEBUGMODWIDGET',
    'source' =>'non-db',
);
 
$dictionary['Case']['relationships']['cases_aleksDebugModWidget'] =   array (
            'lhs_module'=> 'Cases',
            'lhs_table'=> 'cases',
            'lhs_key' => 'id',
            'rhs_module'=> 'aleksDebugModWidget',
            'rhs_table'=> 'aleksDebugModWidget',
            'rhs_key' => 'aleksDebugModWidget_id',
            'relationship_type'=>'many-to-many' 
); 
  

And here are some lines of the manifest.php:

     'layoutdefs'=> array(
        array(
            'from'=> '<basepath>/layoutdefs/cases_layout_defs.php', 
            'to_module'=> 'Cases',
        ),
    ),
 
    'relationships'=>array(
        array(
            'module' => 'Cases',
            'meta_data' => '<basepath>/relationship/cases_aleksDebugModWidgetMetaData.php',
            'module_vardefs' => '<basepath>/vardefs/cases_vardefs.php',
            //'module_layoutdefs'=>'<basepath>/layoutdefs/cases_layout_defs.php'
        ),
    ), 
  

I am still having the same error:

The widget is not appearing

Besides, I am getting confised with the choice of Cases or Case in a place.
The module is "Cases"!!

Regards,

[anna]

Yeah, the use of plural and singular of the module name is pretty confusing, to say the least It looks like you got it right, though.

These are the following suggestions:

• 1. Did you customize your tabs before installing your module and is your custom module displaying in the tabs? If yes, it should also work as a subpanel.
• 2. If you customized your tabs and your module is NOT displaying in the tabs, try going to Admin -> configure tabs and make sure your module is put into the 'displayed tabs'. I believe if you customize the tabs once, all newly installed module will automatically be put in the 'hidden tabs' and you need to manually bring them into the displayed ones.
• 3. If your module is NOT intended to be displayed in the tabs, make sure you included something like this under $your_module/application/mod_app_strings.php
  

   $modules_exempt_from_availability_check['Creditcards']='Creditcards'; 
    

  The same file also should contain this line, otherwise your module won't work at all:
  

   $app_list_strings['moduleList']['Creditcards']='Creditcards'; 
    

  This file should be included in the manifest like this:
  
  

     'language'=> array(
     array('from'     => '<basepath>/application/mod_app_strings.php', 
           'to_module'=> 'application',
           'language' => 'en_us'
     ),( 
    

• 5. Check the custom directory to make sure sure vardefs.ext.php and other ext files were properly generated
• 6. Check the relationships table in the DB to make sure that your relationship was registered

Sorry, gotta head out now. This is a starter ... try it, and see if it helps.

[youssefaoun]

Not working yet:

I have checked:
sugracrm/custom/Extension/modules/Cases/Vardefs

and I saw a file named after my module aleksDebugModWidget.php

it contains:

 $dictionary['Case']['fields']['aleksDebugModWidget'] = array (
    'name' => 'aleksDebugModWidget',
    'type' => 'link',
    'relationship' => 'cases_aleksDebugModWidget',
    'vname' => 'LBL_ALEKSDEBUGMODWIDGET',
    'source' =>'non-db',
); 
  

The same under
sugracrm/custom/Extension/modules/Cases/Layoutdefs

and I saw a file named after my module aleksDebugModWidget.php

it contains:

 $layout_defs['Cases']['subpanel_setup']['aleksDebugModWidget'] = array(
    'order' => 150,
    'module' => 'aleksDebugModWidget',
    'subpanel_name' => 'default',    //this is the name of the file
    'get_subpanel_data' => 'aleksDebugModWidget',
    'add_subpanel_data' => 'aleksDebugModWidget_id',
    'title_key' => 'LBL_ALEKSDEBUGMODWIDGET_SUBPANEL_TITLE',
    'top_buttons' => array(array('widget_class' => 'SubPanelTopSelectButton'),),
); 
  

finally under Language I found: en_us.aleksDebugModWidget.php
it contains:

 $mod_strings['LBL_ALEKSDEBUGMODWIDGET_SUBPANEL_TITLE'] = 'Module Link'; 
  

I ran all the repair scripts... nothing runs.


What to do?

[anna]

Sorry to hear that you still can't get it to work. Your definitions look fine, so I am not sure what the problem is.
Can you verify that you have these files: vardefs.ext.php, layoutdefs.ext.php under /custom/modules/Cases/Ext/Vardefs and Layoutdefs, respectively? These should be generated from the files that you said you found when you rebuild relationships.

Another suggestion that might seem a bit 'strange' - I would change all the names that you use as keys (eg aleksDebugModWidget) to all lower case and stick with it. A lot of things in Sugar are just automatically put to lower or upper case before processing. I haven't come across any subpanel definitions that use mixed case, so that might be a sign that it HAS to be all lowercase. Check out the file include/SubPanels/SubPanelDefinitions.php and search for load_relationships, for example. The name of the subpanel is converted to lower case there, so that seems like it would cause a problem with your setup.

Good luck.

[youssefaoun]

Thank you very much for your help.

In fact "rebuilding" solved the problem..

[andydreisch]

Hi youssefaoun, just checking. Was it the rebuild alone or did you also have to do some of anna's other suggestions?

Thanks,

Andy

[youssefaoun]

Actually I rebuilt it manually..

By the way, since you are a team member, I would like to say something about SugarCRM:
- I had to proceed by changing the name of Widget example in order to make a new Module. Building a module from scratch based on personal understanding is Mission Impossible
- Code that doesn't work as expected leaves you wondering why!!?? for example, to make the widget example ran, I had to forget all my work from scratch and go the dummy way, Pasty my new module's name in Widgets example.

Regards,

[andydreisch]

youssefaoun, please be sure to participate in and review the Release 5.0 Developer Preview.

We're taking great strides in Release 5.0 w/r/t easing the new module creation process.

We'd like your feedback.

Andy