gcoop-libre / sugar-graphviz

draw entity diagram relationships of SugarCRM modules including custom tables

SugarGraphviz

Draw ERD (Entity Relationship Diagram) of SugarCRM Community Edition or SuiteCRM modules including custom tables.

Originally the sugar-graphviz script was tested with versions v4.5, v5.0, v5.1, v5.5 and v6.0 of SugarCRM Community Edition, the first public versión was released on 2009-05-05 in SugarForge

The graph is auto-generated based on the records in the database's relationships table.

date	tag	description
2022-08-28	v1.0.0	Extras from v1.0.0 released on 2009-05-05 on SugarForge
2024-03-04	v1.1.0	Add parameters (port

Dependencies

You need to have the graphviz package installed and access to a SuiteCRM database. To generate the documentation in PDF, the rst2dpf package is required.

In Debian execute:

apt install default-mysql-client graphviz rst2pdf

Examples

Usage

First create file config.php with base configuration or you can also create a symbolic link to the file _config_.php of a SuiteCRM instance and add the -c parameter to read the config.php and specify the name of the module (e.g. calls) in the -m parameter.

Draw single module

  sugar-graphviz.sh -c -m calls

	Left Tables: 12
	Right Tables: 6
	Join Tables: 4
	Total Custom Tables: 7
	Total Tables: 29
	Simple Relationhips: 16
	Left Join Relationhips: 4
	Right Join Relationhips: 4
	Total Relationships: 24
	Write suitecrm85-relationships-calls.png
	suitecrm85-relationships-calls.png PNG 1377x631 1377x631+0+0 8-bit sRGB 106817B 0.000u 0:00.000

Draw all modules

  sugar-graphviz.sh -c -m all

	Left Tables: 50
	Right Tables: 85
	Join Tables: 56
	Total Custom Tables: 8
	Total Tables: 199
	Simple Relationhips: 329
	Left Join Relationhips: 60
	Right Join Relationhips: 116
	Total Relationships: 505
	Write suitecrm85-relationships.png
	suitecrm85-relationships.png PNG 14279x4168 14279x4168+0+0 8-bit sRGB 9.05379MiB 0.000u 0:00.000

License

GNU General Public License, GPLv3.

Author Information

Originally the sugar-graphviz script was tested with versions v4.5, v5.0, v5.1, v5.5 and v6.0 of SugarCRM Community Edition, the first public versión was released on 2009-05-05 in SugarForge

This repository was created in 2010 by Osiris Alejandro Gomez, worker cooperative of gcoop Cooperativa de Software Libre.