Table Row Count Plug-in

Introduction

This article introduces the Table Row Count Plug-in, which is a plug-in version of the sample code introduced in the "Count table rows" article.

This plug-in inserts the number of rows that a table has into a number field, when a record is saved.

Plug-in file

The packaged sample plug-in zip file can be downloaded from the Releases page on GitHub.
Install the plug-in into your domain by following the plug-in installation guide on the Help page.
You can then add the plug-in to a specific App by following the plug-in adding guide on the Help page.

Overview

To set up the plug-in, the Kintone App must have a Table and a number field in its form.
Check the Kintone Help Pages to understand how to create tables in the form.

countTableRows02.png

 

There are two settings for this plug-in.

For the first setting, select a Table from the drop-down list. The Table names listed in the drop-down are the field code names of the Tables.

For the second setting, select a Number field from the drop-down list.

 

Image_3.png

 

After saving the plug-in settings and updating the App, the plug-in's features will run when a record is saved, by counting the number of rows in the specified Table, and then inserting the number into the specified Number field.

countTableRows-compressor.gif

 

File structure

The sample codes used in the plug-in are listed under the src file in our GitHub repository.

The plug-in is created with the following file structure:

 

plug-in/
├── html/
│            └──── config.html
├── css/
│            ├──── 51-modern-default.css
│            └──── config.css
├── js/
│            ├──── config.js
│            └──── desktop.js
├── image/
│            └──── tower.png
└── manifest.json

 

config.html

This file builds the HTML of the plug-in settings page.
Each <div> tag with the "block" class represents 1 row of related HTML elements.

tablerowcounthtml.png

 

The first "block" contains the HTML of the first settings, where the user chooses which Table field to count the rows from. A select tag is stated in the HTML, that creates a drop-down field with a value of "-----". This drop-down field is later populated by the config.js file.

<div class="block">
<label class="kintoneplugin-label">
<span id ="container_label">Table Rows</span>
<span class="kintoneplugin-require">*</span>
</label>
<div class="kintoneplugin-row">Please select a table</div>
<div class="kintoneplugin-select-outer">
<div class="kintoneplugin-select">
<select id="select_table_field" name="select_table_field">
<option value="">-----</option>
</select>
</div>
</div>
</div>

The second "block" contains the HTML of the second settings, where the user chooses which Number field will hold the final count of the table rows. Similar to the first settings, a select tag is stated in the HTML that creates a drop-down field with a value of "-----". This drop-down field is also later populated by the config.js file.

<div class="block">
<label class="kintoneplugin-label">
<span id ="container_label">Number field for Table row count</span>
<span class="kintoneplugin-require">*</span>
</label>
<div class="kintoneplugin-row">Please select a number field</div>
<div class="kintoneplugin-select-outer">
<div class="kintoneplugin-select">
<select id="select_number_field" name="select_number_field">
<option value="">-----</option>
</select>
</div>
</div>
</div>

Both drop-down fields in the blocks have ids allocated to them, so that they can be targeted and populated by the config.js file.

51-modern-default.css

This CSS file is provided on GitHub. This file styles HTML elements on the plug-in config page to fit in with Kintone's UI.
We recommend that you do not make changes to 51-modern-default.css. If you need to style additional elements, or over-ride the default styles, those changes should be added into config.css.

config.css

This supporting CSS file is used to style some areas of the plug-in config page that 51-modern-default.css doesn't cover.

config.js

The function setDropDown is called when the plug-in setting page loads. It uses the kintone.api() wrapper from the JavaScript API to call the REST API endpoint Get Form Fields. Get Form Fields returns an object that contains the form fields for the specified App.
Depending on the endpoint called, Get Form Fields can return either the deployed form fields (the user has clicked Update App in the App Settings and the changes have been committed) or the preview form fields (the form has been saved in the App settings, but the user has not clicked Update App and committed them). This function uses the preview endpoint as users may access the plug-in settings page before they are ready to commit their changes.

function setDropDown() {
    // Retrieve field information, then set dropdown
    return kintone.api(kintone.api.url('/k/v1/preview/app/form/fields', true), 'GET',
        {'app': kintone.app.getId()}).then(function(resp) {
            ...
...
//run rest of code here after retrieving preview form information from the App //resp contains the response data ...
... }, function(resp) { return alert('Failed to retrieve field(s) information'); }); }

 

As this plug-in needs to use Tables and Number fields to populate the drop-down fields in the plug-in settings, the fields with type value of SUBTABLE (the Table field) and NUMBER (the Number field) are extracted from the returned object. The extracted selections are then appended to the element with the ids of select_table_field and select_number_field to make a drop-down list of Table fields and Number fields in the App.

        for (var key in resp.properties) {
            if (!resp.properties.hasOwnProperty(key)) {
                continue;
            }
            var prop = resp.properties[key];
            var $option = $('');

            switch (prop.type) {
                case 'SUBTABLE':
                    $option.attr('value', prop.code);
                    $option.text(prop.code);
                    $('#select_table_field').append($option.clone());
                    break;
                case 'NUMBER':
                    $option.attr('value', prop.code);
                    $option.text(escapeHtml(prop.label));
                    $('#select_number_field').append($option.clone());
                    break;
                default:
                    break;
            }
        }

At the end of the setDropDown function, the code looks through the CONF object where any saved setting data are stored. If it's the first time for the user to use the plug-in, there are no saved values, thus no values are placed in the settings of the plug-in settings page. If the user has saved any settings before in the plug-in (which are stored using Kintone's setConfig API), then those saved values (the specified Table field and Number field) are inserted into the designated plug-in settings.

 // Set default values
$('#select_table_field').val(CONF.table_row);
$('#select_number_field').val(CONF.row_count);

desktop.js

This file runs on the regular pages of the App, such as the Record List and Record Details pages, but not on the App Settings page. This file uses the sample code included in the article "Count table rows". The code used in this plug-in is mostly the same, but it's wrapped in an immediate function with the plug-in ID value as the input parameter. The plug-in ID value is needed for several JavaScript API calls, such as Kintone's getConfig API that retrieves data that was saved in the plug-in settings page using the setConfig API.

// Get plug-in configuration settings
var CONFIG = kintone.plugin.app.getConfig(PLUGIN_ID);

Data retrieved with the kintone.plugin.app.getConfig(PLUGIN_ID) method are allocated to variables.

 var TABLEROWS = CONFIG.table_row; // Field code of the table
var ROWCOUNT = CONFIG.row_count; // Field code of the number field

These variables are used to identify the correct property of the event object when the Save button is clicked (using the app.record.create.submit and app.record.edit.submit event).

//Count the number of rows in the table
var num_of_rows = eventobj.record[TABLEROWS].value.length;

//Set a new value in a field, listed in the event object eventobj.record[ROWCOUNT].value = num_of_rows;

The rest of the code in desktop.js is mostly the same as the code in the "Count table rows" article.

manifest.json

The manifest file states the paths of the files that will be used in the plug-in. It also links to the jQuery library hosted on the Kintone CDN, so that it can be called in the other JavaScript files.

"js": [
    "https://js.kintone.com/jquery/3.3.1/jquery.min.js",
    "js/config.js"
]

The array in the value of the required_params key states which settings in the plug-in config page are required. If these settings are not saved using the setConfig API, errors will be displayed on other pages of the App, stating that the plug-in settings have not been configured yet. 

"required_params": [
"table_row",
"row_count"
]


The namedescription, and homepage_url key-value pairs are labels and links displayed in the plug-in settings.

"name": {
"en": "Table row count Plug-in"
},
"description": {
"en": "This sample plug-in counts the number of rows you have in your table, and places that number in the specified field when you save your record."
},
"homepage_url": {
"en": "https://developer.kintone.io/hc/en-us/articles/360010196073"
}

Finally

Licenses

This plug-in is open sourced under the MIT License. It allows open- or closed-sourced distribution, including commercial use.
If you would like to add more functionality to the plug-in, you are welcome to clone our repository to make your own changes and redistribute it. We generally do not accept external pull requests for the sample plug-in as this repository exists for educational purposes.

If you have any questions related to building Kintone plug-ins, please post your question in the kintone developer network community.

Contribution

This sample plug-in was created with the contribution of Fuji Business International
https://www.linkedin.com/in/mfujinoki/

Was this article helpful?
0 out of 0 found this helpful
Do you have any questions or issues related to this article?
Please share your views with us in the Community forums!