Development tutorial

erwin

The development tutorial has a little problem: the "Next" button is missing on many pages and to access the next chapter of the tutorial the back to the main page is needed.
The tutorial page of the instalation of new modules is not updated to new epesi version. I try to install a new custom module, it does not appear on the instalation module page nor after refresh and no error has appeared. A previous one worked without problems, but is derived from Asset module after changing names of files and functions accordingly.

ethnar

Hello,

I added missing navigation links, thank you for the report.

As for a new module not being recognized:
- Please make sure that the path and filename match the class name contained in each of the files
- Please check if your module appears in Modules Setup when switching to Advanced View (action bar button)
If you're sure the class names match the file structure and you still can't see your module in Advanced View, the fastest way to resolve this problem is if you could post your module here. If not possible, please post some snippets, describe where your module is placed, what's the installation file name and the class declaration from the install file.

The file structure didn't really change for a long time and the tutorial is still considered up-to-date.

Kind regards,
Arek

erwin

Thanks, Arek!
The module is named "Orders", I'd double checked names/directories and seems OK, maybe is in conflict with something?

ethnar

Hello,

There's little room for this kind of conflicts and if any would occur, you'd most likely end up with an error message.

If your module is not being recognized, make sure to check the following:
- your module files can be found in /modules/Orders/ folder
- installation file is named OrdersInstall.php
- installation file defines class OrdersInstall
- all files and folders can be accessed (read/execute) by the http user.
- make sure to check for typos and upper/lower case letters.

You can also try to access the install file by going: http://<epesi_address>/modules/Orders/OrdersInstall.php and you should get the following message:

Direct access forbidden

If you are not getting this message, this means there's a problem with one of the points listed above is the reason for the problem.

If you can see the message then I'm afraid that without the code (all we need is the install file really), we won't be able to help resolve this issue.

Kind regards,
Arek

erwin

The location of the module's files is
<epesidir>/modules/CRM/MyOrders/
The MyOrdersInstall.php cause "Direct access forbidden" message. The module was created by change names and fields in the Product module which worked, previously derived from the original epesi Assets module:

<?php

/**

 * 

 * @author Octavian Blagoi

 * @copyright Tavi Bit Service SRL

 * @license MIT

 * @version 0.1

 * @package epesi-CRM

 * @subpackage MyOrders

 */

defined("_VALID_ACCESS") || die('Direct access forbidden');

class CRM_MyOrdersInstall extends ModuleInstall {

    public function install() {

	Base_LangCommon::install_translations($this->get_type());

        $fields = array(

            array(

                'name'=>'order id',

                'type'=>'calculated',

                'param'=>Utils_RecordBrowserCommon::actual_db_type('text', 16),

                'extra'=>false,

                'visible'=>true,

                'display_callback'=>array('CRM_MyOrdersCommon', 'display_order_id')

            ),

            array(

                'name'=>'Active',

                'type'=>'checkbox',

                'extra'=>false,

                'visible'=>true,

                'filter'=>true

            ),

            array(

                'name'=>'Company Name',

                'type'=>'text',

                'param'=>'128',

                'extra'=>false,

                'visible'=>true,

                'required'=>true

            ),

            array(

                'name'=>'Order Tag',

                'type'=>'text',

                'param'=>'128',

                'extra'=>false

            ),

            array(

        	'name'=>'Order Date',

        	'type'=>'date',

        	'extra'=>false,

		'visible'=>true

            ),

            /*************** DETAILS ***************/

            array(

        	'name'=>'Product Id',

        	'type'=>'commondata',

        	'extra'=>false,

        	'visible'=>true,

        	'required'=>true

            ),

            array(

        	'name'=>'Product Name',

        	'type'=>'text',

        	'param'=>'128',

        	'extra'=>false

            ),

    	    array(

		'name'=>'Unit',

		'type'=>'text',

		'param'=>'4',

		'visible'=>true,

		'extra'=>false

	    ),

            array(

        	'name'=>'Sale Price',

        	'type'=>'currency',

                'visible'=>true,

        	'extra'=>false

            ),

            array(

                'name'=>'Quantity',

                'type'=>'float',

                'visible'=>true,

                'extra'=>false

            ),

            array(

                'name'=>'Value',

                'type'=>'float',

                'visible'=>true,

                'extra'=>false

	    )

	    

        );

        Utils_RecordBrowserCommon::install_new_recordset('crm_MyOrders', $fields);

        Utils_RecordBrowserCommon::set_recent('crm_MyOrders', 10);

        Utils_RecordBrowserCommon::set_favorites('crm_MyOrders', true);

        Utils_RecordBrowserCommon::set_caption('crm_MyOrders', 'MyOrders');

        Utils_RecordBrowserCommon::set_quickjump('crm_MyOrders', 'order Name');

        Utils_RecordBrowserCommon::set_icon('crm_MyOrders', Base_ThemeCommon::get_template_filename('CRM/MyOrders', 'icon.png'));

        Utils_RecordBrowserCommon::register_processing_callback('crm_MyOrders', array('CRM_MyOrdersCommon', 'process_request'));

        Utils_RecordBrowserCommon::enable_watchdog('crm_MyOrders', array('CRM_MyOrdersCommon','watchdog_label'));

	Utils_RecordBrowserCommon::add_default_access('crm_MyOrders');

        Utils_RecordBrowserCommon::new_addon('company', 'CRM/MyOrders', 'MyOrders_addon', 'MyOrders');

	Utils_AttachmentCommon::new_addon('crm_MyOrders');

        return true;

    }

    public function uninstall() {

        Utils_CommonDataCommon::remove('crm_MyOrders_category');

        Utils_CommonDataCommon::remove('crm_MyOrders_monitor_type');

        Utils_CommonDataCommon::remove('crm_MyOrders_printer_type');

        Utils_RecordBrowserCommon::delete_addon('company', 'CRM/MyOrders', 'MyOrders_addon');

	Utils_AttachmentCommon::delete_addon('crm_MyOrders');

        Utils_AttachmentCommon::persistent_mass_delete('crm_MyOrders');

        Utils_RecordBrowserCommon::uninstall_recordset('crm_MyOrders');

        Utils_RecordBrowserCommon::unregister_processing_callback('crm_MyOrders', array('CRM_MyOrdersCommon', 'process_request'));

        return true;

    }

    public function version() {

        return array("0.1");

    }

    public function requires($v) {

        return array(

            array('name'=>'Base/Lang','version'=>0),

            array('name'=>'Utils/RecordBrowser','version'=>0),

            array('name'=>'CRM/Contacts','version'=>0));

    }

    public static function info() {

        return array(

            'Description'=>'This module helps you to manage Orders',

            'Author'=>'Octavian Blagoi <tavi343@gmail.com>',

            'License'=>'MIT');

    }

    public static function simple_setup() {

        return array('package'=>'CRM', 'option'=>'MyOrders');

    }

}

?>

I want to link this module by the field "Product Id" with the Products module and tables with a selection list. How can I do this?

ethnar

Hello,

I'm not really sure what else I can suggest to resolve the situation. I created folder MyOrders on my local installation, I created the MyOrdersInstall.php file, pasted your code, went to my EPESI front-end, selected "Rebuild modules database" and your module shows up in the Advanced setup. Looking at the code I see you also included Simple setup category and sure enough, your module shows up as optional component for CRM package.
You get the message Direct access forbidden, so it's a not a permission issue.

You could try and add new row in available_modules table, with your module name (CRM_MyOrders) and vkey 0, enter modules administration and try to install it. If you get an error, that should get us somewhere. If you're not getting any errors, it'd mean there's a problem with refreshing modules database.

Failing that, the only thing is to debug the code and to see what's exactly going on in there. If you want, we can help investigate the issue on-site, but we'd require access to the installation (FTP would be sufficient). If you want, please contact me via PM on forums with details. I'm afraid I can't do much more than that at the moment.

Kind regards,
Arek

erwin

Thank you, I will try later your advice. I've created the module on a test instalation on my own site. I will try to delete and recreate the module on production site.

erwin

Only after I added the missing record in the availlable_modules table I have solved this problem. The username of the database at installation of epesi and the username of the administrator in epesi are different, could be this an issue?

ethnar

If adding the module directly to available_modules resolved the problem, this means that the mechanic for rebuilding modules database is not working properly. We'd be very much interested in investigating it further, but we're unable to reproduce the problem.

As for the usernames/passwords:
The username/password you supply to connect to database is entirely different matter than any username you create/use for EPESI. The database user/pass must be created on the database side and must have sufficient privileges to operate on the database - if your EPESI is worknig, then this part is covered and you don't need to anything else.
The administrator username/password can be absolutely anything the system allows you to enter and as such it is in no relation to the database user.

If you find any traces as to why refreshing modules list doesn't work properly on your installation, please share this information with our team.

Kind regards,
Arek

erwin

OK, thank you very much! Unfortunately, I have not enough experience with php and epesi development, but I learn everyday.

erwin

I've read the Record Browser tutorial and study some part of modules code. But I cannot figure out how to use it in several cases. The tutorial will be more comprehensive if you put there actual pieces of code from epesi modules as examples.

For example, I cannot make a simple select field to work corectly. I need an ASC ordered list of field from another module, filtered by typing letters and then get some other fields from that table when validate the field to put in the actual module. I did't find an example in epesi modules yet.

ethnar

Hello,

The auto-select feature (searching records in select elements by typing) should now work properly for any select field handled by EPESI, providing that the required condition is met - at least 50 records match the criteria. In the upcoming 1.3.1 version you will be able to change this limit via User Settings.
This means adding the usual select field should give you the first part of the functionality you require.

As for the 2nd part - the code you want to execute - is it to prevent the user from entering the wrong data (that's form validation) or do you want the system top take an action (execute some code) when the data is submitted?
If it's the first case - it's slightly tricky when it comes to select fields. Normally these things are handled within QFfield_callback of the field that requires validation, but since it's easier to rely on RecordBrowser to create this field, you may want to avoid setting QFfield for that particular field. A quick workaround is to attach the form rule in QFfield of another field - the only limit is that the field must be placed after your select field.
If it's the other scenario thou, it's much, much easier. All you need is the processing callback:
http://www.epesi.org/index.php?title=Ut ... riggers.29
There are quite a few examples on using processing callbacks in EPESI code, one of the best examples being Premium/Tickets/TicketsCommon, submit_ticket()

I know that the documentation is not exactly perfect, but we have very limited resources and oftentimes the questions we're asked are so specific we simply couldn't cover them all in an organised manner in any kind of manual.
In case of any questions, you are welcome to post them here and we'll do our best to provide a comprehensive answer.

Kind regards,
Arek

erwin

Thank you for the answer. It's a little bit difficult for me to think in OOP after more than 20 years of procedural programming. I knew is a hard work to write an exhaustive manual, so I try to learn by examples and adapting Epesi ready-made code for my needs.

In the custom module "Orders" I want to select the product from the product name field list and then get the product id, the sale price, unity and after the user completed the quantity field the next step is to calculate the value of the product and the total value of transaction on the order. The Products module is a simple table module, but the Orders must be related to Company and Products tables. When the user input a new company the add company method must be called.

Best Regards,
Tavi
P.S. Progress so far:
- I use the employees and companys fields&functions with select from the Tickets module, it's OK now, but the employee field is required to be the actual user with user as a default employee like in the Tasks module.
- The date field cause an error and don't display the calendar popup. How to make the link to the calendar applet?
- I'm trying to link the Product Name in the Orders table with the Product Name in the Products table using the model from Contacts module => lot off errors :twisted:

ethnar

Hello,

Just a quick note on the date field - if the popup calendar is not displayed properly, this means there was a Javascript error somewhere along the way to the screen where you try to use the popup calendar. Check for any JS errors you encounter in EPESI and if you can get them fixed, the popup calendar should work.

Good luck with your work!

Kind regards,
Arek

erwin

Hello,
I don't know how to find JS errors in EPESI. There is a parser or something to use? In other EPESI modules the calendar popup is displayed and work.

In developing the Orders module I manage to link it with the Company table using a select field, but I cannot solve errors when I try to link it with the Products Module I wrote using the methods from Projects/Tickets as an example.

Type: 256

Message: RecordBrowser critical failure, terminating. (Requested s:1:"0";, available Array ( [company] => 1 [contact] => 1 [crm_assets] => 1 [crm_meeting] => 1 [crm_Orders] => 1 [crm_Products] => 1 [phonecall] => 1 [premium_projects] => 1 [premium_salesopportunity] => 1 [premium_tickets] => 1 [rc_accounts] => 1 [rc_mails] => 1 [rc_mails_assoc] => 1 [rc_multiple_emails] => 1 [task] => 1 ) )

File: /home/burginfa/public_html/atena/modules/Utils/RecordBrowser/RecordBrowserCommon_0.php

Line=223

error backtrace:

[PHP core called function]

    function called: handle_epesi_error(256, "RecordBrowser critical failure, terminating. (Requested s:1:\"0\";, available Array ( [company] => 1 [contact] => 1 [crm_assets] => 1 [crm_meeting] => 1 [crm_Orders] => 1 [crm_Products] => 1 [phonecall] => 1 [premium_projects] => 1 [premium_salesopportunity] => 1 [premium_tickets] => 1 [rc_accounts] => 1 [rc_mails] => 1 [rc_mails_assoc] => 1 [rc_multiple_emails] => 1 [task] => 1 ) )", "/home/burginfa/public_html/atena/modules/Utils/RecordBrowser/RecordBrowserCommon_0.php", 223, Array ("0", false, true, Array (#15)))

File: /home/burginfa/public_html/atena/modules/Utils/RecordBrowser/RecordBrowserCommon_0.php

    line 223

    function called: trigger_error("RecordBrowser critical failure, terminating. (Requested s:1:\"0\";, available Array ( [company] => 1 [contact] => 1 [crm_assets] => 1 [crm_meeting] => 1 [crm_Orders] => 1 [crm_Products] => 1 [phonecall] => 1 [premium_projects] => 1 [premium_salesopportunity] => 1 [premium_tickets] => 1 [rc_accounts] => 1 [rc_mails] => 1 [rc_mails_assoc] => 1 [rc_multiple_emails] => 1 [task] => 1 ) )", 256)

File: /home/burginfa/public_html/atena/modules/Utils/RecordBrowser/RecordBrowser_0.php

    line 371

    function called: check_table_name("0")

File: /home/burginfa/public_html/atena/modules/Utils/RecordBrowser/RecordBrowser_0.php

    line 222

    function called: show_filters(Array ())

[PHP core called function]

    function called: body(Array ("ASC"), Array (), Array (false))

File: /home/burginfa/public_html/atena/include/module.php

    line 793

    function called: call_user_func_array(Array (Object (Utils_RecordBrowser), "body"), Array (Array (#1), Array (#0), Array (#1)))

File: /home/burginfa/public_html/atena/include/module.php

    line 713

    function called: get_html_of_module(Object (Utils_RecordBrowser), Array (Array (#1), Array (#0), Array (#1)), null)

File: /home/burginfa/public_html/atena/modules/CRM/Orders/Orders_0.php

    line 25

    function called: display_module("Object (Utils_RecordBrowser)", Array (Array (#1), Array (#0), Array (#1)))

[PHP core called function]

    function called: body()

File: /home/burginfa/public_html/atena/include/module.php

    line 793

    function called: call_user_func_array(Array (Object (CRM_Orders), "body"), Array ())

File: /home/burginfa/public_html/atena/include/module.php

    line 713

    function called: get_html_of_module(Object (CRM_Orders), null, null)

File: /home/burginfa/public_html/atena/modules/Base/Box/Box_0.php

    line 145

    function called: display_module("Object (CRM_Orders)")

File: /home/burginfa/public_html/atena/include/epesi.php

    line 209

    function called: body()

File: /home/burginfa/public_html/atena/include/epesi.php

    line 265

    function called: go(Object (Base_Box))

File: /home/burginfa/public_html/atena/process.php

    line 32

    function called: process("parent_module=CRM_Orders&box_main_href=801787f7f4cf2db543d333247ec2b1d0", false)

I don't know what this error is about, the module is not displayed, but there is no error message when I've install it.

Best regards,
Tavi

ethnar

Hello,

To track Javascript errors we recommend to use either Chrome console (available with default installation of Chrome) or Firebug console for Firefox (Firefox addon). In the console you'll get the general JS error that occurs and it should point to general location where the error is occurring.

As for your second error - it seems you've created a select field, but the parameter for this field is not set properly. Please refer to select/multiselect parameters section on wiki:
http://www.epesi.org/index.php?title=Ut ... _parameter

Kind regards,
Arek

israes

[quote:1yau50ov]If your module is not being recognized, make sure to check the following:
- your module files can be found in /modules/Orders/ folder
- installation file is named OrdersInstall.php
- installation file defines class OrdersInstall
- all files and folders can be accessed (read/execute) by the http user.
- make sure to check for typos and upper/lower case letters.

You can also try to access the install file by going: http://<epesi_address>/modules/Orders/OrdersInstall.php and you should get the following message: Direct access forbidden

..........

Hello everybody!

i've read this topic from the begining because i was experimenting the same error like erwin, I was studying the wiki and get stuck at http://www.epesi.org/index.php?title=Install_new_module

So let me contribute to replicate this issue. First of all, i'm using the same module name as the wiki and when i go to Home->Administration->Modules Administration there is no more the Scan for new modules button, instead there is Rebuild modules database. In my case at advanced view in modules setup tab the Rebuild modules database button didn't work. But at simple view interface in Available tab I click on Rebuild modules database and finally work.

So definitely there's a problem with refreshing modules database.

ethnar

Hello,

I corrected the issue on the wiki, thank you for pointing that out.

I can confirm that the "Rebuild modules database" action indeed has its issues in Advanced View in version 1.3. Our top priority right now is to release 1.3.1 version that is rid of this and some other issue.

I apologize for the inconvenience caused.

Kind regards,
Arek

israes

Sounds great Arek.

Thanks for you support.

Epesi ENS | Epesi Academy | epesi.cloud PaaS | GitHub

Help Me! | Download from SourceForge