Creating a Custom Dashlet

[brandonbryan12]

Hello all,

I have two questions:

• I am currently attempting to create a custom Civi report. I've spent some time searching through the code, but the amount of abstraction in this process leaves me a tad confused. So, I'd like to know, programatically, how a report is created and added to the dash as a dashlet.
• Is there any way to hijack the code of dashlets and insert, say, a Drupal View or other custom views?

Thank you for your time.

EDIT:
We at Skvare have created a Drupal module that integrates Views into dashlets.
You can read the blog post here: https://civicrm.org/blogs/brandonferrell/drupal-views-civicrm-dashlets
And you can view the project page here: https://www.drupal.org/sandbox/brandonferrell/2389543

[totten]

I'm not certain how the report<=>dashlet mechanism works, but the dashlets are registered in table called "civicrm_dashboard". Basically, you provide a name, title, and some AJAX callback URLs. You might experiment a bit inserting a record to see what happens.

If your goal is to write a Drupal module or Civi extension which defines a dashlet, then you can use the "Dashboard API" in v4.4+ to register the dashlet. See also:

 * civicrm/api/explorer (e.g. "http://my-site.org/civicrm/api/explorer")
 * civicrm/api/doc (e.g. "http://my-site.org/civicrm/api/doc")
 * https://civicrm.org/blogs/totten/api-and-art-installation

If you need to influence the dashlets that are activated for users, then these might be interesting:

 * Declarative defaults: hook_civicrm_dashboard_defaults - https://github.com/civicrm/civicrm-core/blob/4.4/CRM/Utils/Hook.php#L1392
 * Procedural manipulation: https://github.com/civicrm/civicrm-buildkit/blob/master/app/config/drupal-demo/install-dashboard.php

[Michael McAndrew]

Hey brandonbryan12,

If you do manage to get a drupal view in there, I would be really interested to know how you did it. Feel free to post your code here if you do.

Michael

[brandonbryan12]

I'm not certain how the report<=>dashlet mechanism works, but the dashlets are registered in table called "civicrm_dashboard". Basically, you provide a name, title, and some AJAX callback URLs. You might experiment a bit inserting a record to see what happens.

If your goal is to write a Drupal module or Civi extension which defines a dashlet, then you can use the "Dashboard API" in v4.4+ to register the dashlet. See also:

 * civicrm/api/explorer (e.g. "http://my-site.org/civicrm/api/explorer")
 * civicrm/api/doc (e.g. "http://my-site.org/civicrm/api/doc")
 * https://civicrm.org/blogs/totten/api-and-art-installation

If you need to influence the dashlets that are activated for users, then these might be interesting:

 * Declarative defaults: hook_civicrm_dashboard_defaults - https://github.com/civicrm/civicrm-core/blob/4.4/CRM/Utils/Hook.php#L1392
 * Procedural manipulation: https://github.com/civicrm/civicrm-buildkit/blob/master/app/config/drupal-demo/install-dashboard.php

Thank you for the help! This will definitely help me out in many ways.
If I do get Drupal Views available as dashlets, I will post a link to the repo for sure.

[brandonbryan12]

We at Skvare have created a Drupal module that integrates Views into dashlets.
You can read the blog post here: https://civicrm.org/blogs/brandonferrell/drupal-views-civicrm-dashlets
And you can view the project page here: https://www.drupal.org/sandbox/brandonferrell/2389543

[commonpike]

I have created a Drupal module that integrates Views into dashlets.

Karma+++! Very cool, will check it out.

[petednz]

great to see more views integration - thanks for publishing