Frequently Asked Questions (FAQ)

What do I get by buying Zenbu and Hokoku as a bundle?

When you purchase the Zenbu + Hokoku Bundle, you receive one license each of Zenbu and Hokoku, the same as you would if you bought both add-ons separately, but at a discounted price. Both licenses (and betas if available) will be available in your Account & Downloads section

Frequently Asked Questions (FAQ)

Can I edit multiple custom fields at the same time, similar to basic entry data in EE/Zenbu’s multi-entry editor?

Yes!. Starting with Henshu 1.0, this is possible. Please read the important details about the multi-entry custom field editor.

I can’t see the Edit links/I can only see the Edit links for certain channels. Why is that?

Old answer: Feature deprecated/Not available since 0.7.0

Channels need to have all their fieldtypes whitelisted before using Henshu. This is due to the way the EE Channel Entry API works, and is a precaution to avoid nasty surprises with custom field data disappearing (because of how the Channel Entry API works) when editing other entry data.

Why do I have to whitelist fieldtypes?

Old answer: Feature deprecated/Not available since 0.7.0

Henshu uses the EE Channel Entries API to update entry data. Some custom fields may expect data formatted in a specific way before saving to the database, which the API may not handle correctly. This can result in deletion of this custom field’s entry data.

To prevent data accidental data deletion, Super Administrators (only) are asked to test and whitelist custom fieldtypes before using Henshu in channels that contain them.

You can whitelist fieldtypes that you are sure do not lose their data if another entry data element is edited. When all fieldtypes for a channel are whitelisted, Henshu can be used for that channel.

Whitelisting fieldtypes is at your own risk and your own responsibility.

Frequently Asked Questions (FAQ)

Can I export as an XML file?

Not yet, although I’m hoping to make that possible in the future.

Where are the export files stored?

Export files are stored in your EE cache folder, typically at /system/user/cache.

I’m not getting an export file / The export is stalled at 0% (or any %)

Verify that your EE cache folder (typically at /system/user/cache) has the right permissions. Hokoku uses this folder to build the export file.
See if any errors/warnings appear in your browser console. Hokoku makes ajax calls to build the export file. If you can get the response from these calls from your browser’s web inspector, this is also very useful information. If you have errors/warnings in the console and/or also have the response when the error occurs, please report the error message to Zenbu Studio.

Frequently Asked Questions (FAQ)

Is there an upgrade price from (Zenbu for EE2 or EE3)?

If you have an old license of Zenbu, enter it as a coupon code on checkout and get 50% off your purchase of Zenbu for EE4. If your code doesn’t work, contact Zenbu Studio with your license number and we’ll work things out.

I need the EE2 (or EE3) version of Zenbu!

Please contact Zenbu Studio with your license number for Zenbu for EE2 or EE3 and we’ll arrange to get you a copy. For convenience we used to include the last version of the previous version of Zenbu in the latest package but this ended up confusing some users.

My custom field does not display as expected, why is that?

By default, Zenbu displays data as it is found in the exp_channel_data database table. A few common custom fields have extended support which shows an enhanced display based off the exp_channel_data data. Customized Zenbu display support for third-party fieldtypes can be easily added by third-party developers by adding Zenbu functions in the third-party add-on’s code.

NOTE: Third-party addon support and developer documentation is not yet available, but is planned to be added soon.

Does Zenbu support (insert third-party add-on here)?

Natively within Zenbu, likely no. Only a few custom fields have support within Zenbu (including native EE custom fields). Other custom fields will at least display the contents of exp_channel_data by default. Customized Zenbu display support for third-party fieldtypes can be easily added by third-party developers by adding Zenbu functions in the third-party add-on’s code.

NOTE: Third-party addon support and developer documentation is not yet available, but is planned to be added soon.

I would like a different display style for column X. Is this possible?

Zenbu comes with a few display options for some columns, but additional customization is planned to be available when third-party support and developer documentation is available.

I would like to add a extra column in Zenbu to show X. How can this be done?

Additional customization, such as adding custom columns, is planned to be available when third-party support and developer documentation is available.

Frequently Asked Questions (FAQ)

Can I edit custom fields of multiple entries simultaneously using the multi-entry editor?

No. The same editable fields found in EE’s native multi-entry editor are found in Zenbu, but in a much easier to use and manageable format. However, the ability to multi-edit custom fields is noted as a feature request.

Can I edit the content of columns directly from the entry listing, without having to access the entry form?

Yes! However, this is done through Henshu (Zenbu Edit), an add-on which hooks onto Zenbu and adds this ability.

Can I export the data that is displayed in Zenbu in CSV, HTML, JSON format?

Yes! Using the Hokoku (Zenbu Export) add-on. This adds an Export this search button right within Zenbu and has many options and features.

A logged in user isn’t able to access Zenbu, and gets the following error instead: “An Error Was Encountered. You are not authorized to access this page”. What should I do?

The Zenbu module isn’t enabled for access for your member group. You can enable module access from the member group’s preferences in the Control Panel. Access to Add-ons and Add-ons => Modules under the “Control Panel Access” section must also be enabled. Alternatively, you can enable Zenbu access from Zenbu in the Member Access Settings section.

My custom field does not display as expected, why is that?

By default, Zenbu displays data as it is found in the exp_channel_data database table. A few common custom fields have extended support which shows an enhanced display based off the exp_channel_data data. Customized Zenbu display support for third-party fieldtypes can be easily added by third-party developers by adding Zenbu functions in the third-party add-on’s code. Documentation for adding third-party field support for Zenbu can be found here.

Does Zenbu support (insert third-party add-on here)?

Natively within Zenbu, likely no. Only a few custom fields have support within Zenbu (including native EE custom fields). Other custom fields will at least display the contents of exp_channel_data by default. Customized Zenbu display support for third-party fieldtypes can be easily added by third-party developers by adding Zenbu functions in the third-party add-on’s code. Documentation for adding third-party field support for Zenbu can be found here.

I would like a different display style for column X. Is this possible?

Yes, through building an extension that takes advantage of the available Zenbu hooks to modify column display. More information about these hooks can be found here.

I would like to add a extra column in Zenbu to show X. How can this be done?

Yes, through building an extension that takes advantage of the available Zenbu hooks which can add column(s). More information about these hooks can be found here.

Frequently Asked Questions (FAQ)

…But I need the EE2 version of Zenbu!

No worries. Purchases (or upgrades) of Zenbu for EE3 will include a copy of the latest version available for EE2 of you’re still on EE2.

I can’t edit multiple entries like I could in EE2. Why is that?

This feature leveraged the multi-entry editing feature available in EE2 natively. Unfortunately this feature isn’t available in EE3 anymore, and therefore not available in Zenbu either at this time.

Can I edit the content of columns directly from the entry listing, without having to access the entry form?

Yes in EE2, no in EE3
For EE2, this is done through Henshu (Zenbu Edit), an add-on which hooks onto Zenbu and adds this ability.
For EE3, Henshu isn’t yet available for EE3

Can I export the data that is displayed in Zenbu in CSV, HTML, JSON format?

Yes in EE2, no in EE3
For EE2, using the Hokoku (Zenbu Export) add-on. This adds an Export this search button right within Zenbu and has many options and features.
For EE3, Hokoku isn’t yet available for EE3.

My custom field does not display as expected, why is that?

Does Zenbu support (insert third-party add-on here)?

Natively within Zenbu, likely no. Only a few custom fields have support within Zenbu (including native EE custom fields). Other custom fields will at least display the contents of exp_channel_data by default. Customized Zenbu display support for third-party fieldtypes can be easily added by third-party developers by adding Zenbu functions in the third-party add-on’s code. Documentation for adding third-party field support for Zenbu can be found here.

I would like a different display style for column X. Is this possible?

Yes, through building an extension that takes advantage of the available Zenbu hooks to modify column display. More information about these hooks can be found here.

I would like to add a extra column in Zenbu to show X. How can this be done?

Yes, through building an extension that takes advantage of the available Zenbu hooks which can add column(s). More information about these hooks can be found here.

Frequently Asked Questions (FAQ)

My custom field does not display as expected, why is that?

Zenbu mostly supports native Craft fields, as well as fields who do not use their own tables for data (i.e. non-iterable fields). More complex 3rd-party fieldtypes, especially those that store an array of data, will display the raw stored data in a modal window. You can also customize the display of your third-party fieldtype by using the Custom Display Template feature in Zenbu’s Display Settings (Zenbu 1.2.0+).

I want to search [insert field] using [insert specific way to search]. What are the different search options available?

A list of the different ways items can be searched on can be found on the main Zenbu for Craft page