Documentation - Hokoku (Zenbu Export) for EE3

Installation

  1. Unzip the zip file you have downloaded
  2. Copy the hokoku folder found at system/user/addons/hokoku into your system/user/addons/ folder
  3. In the Control Panel, go to Add-Ons » Modules and click the "install" link next to "Hokoku"
  4. Install both the module and extension
  5. Verify that your EE cache folder (typically at /system/user/cache) has the right permissions (777). Hokoku uses this folder to build the export file.

Update Instructions

  1. Unzip the update zip file you have downloaded.
  2. Copy the hokoku folder found at system/user/addons/hokoku into your system/user/addons/ folder, overwriting its contents.
  3. In the Control Panel, go to Add-Ons » Modules and click the “Run Modules Updates” link in the top right of the screen.
  4. The module list should then show the latest version of the add-on.

Enabling access to Hokoku for other member groups

As Hokoku is a module, to enable access to Hokoku for target member groups outside of Super Admins, module access must be enabled.

  1. As a Super Administrator, go to Add-ons » Modules » Hokoku » Member Access Settings
  2. Under Enable module for the following member groups:, select the member groups which should get access to Hokoku

NOTE: Enabling Hokoku for member groups will also enable display and access to the ADD-ONS and ADD-ONS => Modules sections in the Control Panel’s top navigation. This is a requirement of ExpressionEngine to be able to completely access Hokoku. To disable display/access to these sections afterwards, please visit the individual member group’s preferences.


Usage

Creating your First Export Profile

Hokoku_-_create_profile.png

After installing Hokoku, click on Export this search, then Manage export profiles from Zenbu, or access Hokoku directly from the CP => Add-ons => Modules => Hokoku.

  1. To create a new export profile, select "Create new export profile"
  2. In Profile name, give your export profile a name. This will appear in Zenbu after using the Export this search button and selecting the profile for export.
  3. Select a file format. Choices are currently CSV, HTML and JSON
  4. Under Options, complete the options for your export file format. For the Filename, EE date format characters are accepted, eg.  export_%Y-%m-%d.
  5. (If permitted) Chose to copy this export profile to a member group by selecting it from the list
  6. Save this export profile to save your settings.

Managing Export Profiles

On the main Hokoku page, and depending on your access settings, you can edit or delete export profiles.

  • The ID column is the export profile id, which is used with the {exp:hokoku:export} template tag. 
  • The Template tags column displays a list of {exp:hokoku:export} example tag code to help developers set up export from a template.

Managing Member Access to Export Profiles

In the Member Access Settings section, administrators can set permissions for each member group

  • Can administrator own profiles: users from selected member groups can edit/delete their own export profiles
  • Can view and use group profiles: users from selected member groups can view and use (not edit/delete) export profiles common for the member group. 
  • Can administrator group profiles: users from selected member groups can edit/delete export profiles common for the member group. This is usually for member groups with a more administrative role
  • Can access Member Access Settings: users from selected member groups can access the Member Access Settings section. This is a powerful permissions and should be granted to member groups with more administrative roles.

Exporting from Zenbu

  1. First set up your display columns, options, and filter rules as you normally would in Zenbu.
  2. After displaying a listing of entries, click the Export this Search button next to Zenbu's Save this Search button.
  3. A list of export profiles will be listed. Click the export profile that you want to use.
  4. Wait while Hokoku prepares the file with the contents currently displayed in Zenbu. Once complete, the file will be sent to your browser for download.

Exporting from a Template

The {exp:hokoku:export} tag is used on an EE template to export the Zenby entry data to a file or to screen. Simply place this tag in a template and access that template from your browser. Eg.

{exp:hokoku:export profile_id="1" search_id="1"}

Parameters

profile_id="1"

Required. The export profile_id displayed in the main Hokoku module page.

search_id="3"

Required. The Zenbu saved search ID. You need to first save a search in Zenbu for {exp:hokoku:export} to work. The Template tags links in Hokoku's main module page contain helper {exp:hokoku:export} tags based on each Zenbu saved search.

output_to_screen="y"

Default is "n". Outputs the Zenbu entry data to the template (i.e. on the screen) instead of exported to a downloadable file. Note: the output can be very long depending on how much data you are exporting.

Auto-login on future visits

Forgot your password?

×