Enabling import on a custom module in Sugar 5.0

[clint]

For those of you working with Sugar 5.0, attached is a sample module where I enabled the import function.

Unzip the package and take a look at the contents. The EnableImport directory is where I put the necessary code to enable the import function.

Required Files

1. EnableImport\menus\Import_zz_Work.php - This file is used by the manifest.php to add the Import item to the Work module's shortcuts menu.
2. EnableImport\modules\Import\config.php - This file registers the Work module (zz_Work) as a module that can be imported.
   
   NOTE: This is the one out-of-the-box file that you must modify which means this change is not upgrade-safe. You will need to manually merge the one-line change in this file back into your code when ever you do upgrades in the future.
3. EnableImport\modules\Import\Importzz_Work.php - Contains the logic for actually doing the import. If you need to do any special logic (data manipulation, creating special relationships, etc), you will create special functions in this file that get executed at import.
4. EnableImport\modules\zz_Work\field_arrays.php - This file is necessary but unfortunately a relic from the past. Up until Sugar 5.1, the Import module does not use the standard vardefs for defining a module's required fields but rather keys off of this field_arrays.php file that we used back in Sugar 1.0 and 2.0. So you will need to register all of your module's required fields in this file otherwise your import will fail. Thankfully Sugar 5.1 finally puts this dependency to rest.
5. EnableImport\modules\zz_Work\Import.php - This file actually calls the Import module code when you click on the Import button.

On a final note, be sure to take a look through the manifest.php file for this package to see how I modified it to install these required files.

[DragonflyMaster]

Thank you Clint! I'll look at the code tonight or tomorrow and I'll try to adapt it to my modules

[URtech]

Clint, this is awesome! I'm going to try it out immediately. I'm so thankful you've put this together!

Cheers, Sean

[URtech]

Hi Clint,

I followed all your instructions. I wasn't totally sure about how to complete the field_arrays.php file declarations based on the file you provided didn't appear to match with the zz_Work syntax. In any case, I can now see the "Import" in the menu on my custom module, but when I click it, I get a blank area under "Import Step 1: Select the source" where I'd normally see the options to choose the format to upload.

Any thoughts on why that would happen or what I might be missing?

Thanks!
Cheers, Sean

[clint]

Originally Posted by URtech

I followed all your instructions. I wasn't totally sure about how to complete the field_arrays.php file declarations based on the file you provided didn't appear to match with the zz_Work syntax. In any case, I can now see the "Import" in the menu on my custom module, but when I click it, I get a blank area under "Import Step 1: Select the source" where I'd normally see the options to choose the format to upload.

So let's step through this.

Menu Item
When you install the zz_Work sample module, the Module Loader creates a menu item file based on the entries in manifest file. Specifically the custom/Extension/modules/zz_Work/Ext/Menus/Work.php file gets created. When you run Quick Repair, this file generates your menu entry in your mdoule. So you need a comparable file for your custom module.

Since you have a menu item, it sounds like this is covered.


Import.php in your custom module directory
As you see in the sample module, we install a file called modules/zz_Work/Import.php. This file is necessary to redirect from the zz_Work module to the Import module and carry the zz_Work module reference along with it.

Since you are seeing the Import module when you click on the menu item, it sounds like you have the proper Import.php file in your custom module directory.

Import config.php
Have you modified the modules/Import/config.php file to register your module in the $import_bean_map[] array? It needs to point to the prefix for the file that will do the actuall import logic.

For example in the zz_Work sample module, you will see in the modules/Import/config.php file on line 54 that I added the following:

PHP Code:

,'zz_Work' => 'Importzz_Work' 


The syntax here is very important. The array entry key "zz_Work" (left side) has to match the module name (not the bean name, but the module name). The array entry value "Importzz_Work" (right side) has to match the file prefix for the new file you will create that contains the actual import logic for your new module. In this case, Importzz_Work maps to the modules/Import/Importzz_Work.php file.

My guess is that you have either not properly registered the new modle in the $import_bean_map[] array or your have not created the modules/Import/Import<your_module>.php file.

[URtech]

HI Clint,

I just double-checked each of the things you mentioned and no luck. I'm attaching the zip here and would appreciate if you could take a quick look.

Thanks!
Cheers, Sean

[clint]

Hi Sean -

I suggest turning on php error notices in your development instance. When I clicked on Import in your Institutions module, I get the following php error:

Fatal error: Cannot redeclare ImportURMOD_Institutions::$related_modules in C:\Inetpub\wwwroot\sugarpro\modules\Import\ImportU RMOD_Institutions.php on line 63

Once I commented out line 63 in your file, the import screen appeared properly.


Best,
Clint

[URtech]

Thanks Clint! I had actually just now figured that syntax error out and have a simple test working. I appreciate the php error logging reminder. Thanks again for this "how to" and for the thoughtful follow up.

Cheers, Sean

[nckman]

Are there resources that might help to install this? I'm converting from Salesforce and have several custom modules / data that need to be imported. Outside of this tool, are there any other recommendations on how to import to a custom module?

[sanjeev1225]

Hi clint


I download the u r zip file and i installed through module loader .I got a another tab name Work .

when i create a wrok in that module all the button like save ,cancel are not working

and in shorcuts work icon was error image showing .I don't know that much of knowledge of this works module.Will u plz explain the feautures of this perticular module compare with other.

Iam using SugarCE-Full-5.0.0b

Thanks in Advance