Table Numbering Plug-in

Introduction

This article introduces the Table Numbering Plug-in, which is a plug-in version of the sample code introduced in the "Numbering Tables" article.

Upon saving a record, this plug-in will automatically fill in the specified Number field of the specified Table with row numbers. Users will also not be able to edit the specified Number field when entering data into the record.

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 that include a Number field in its form.
Check the Kintone Help Pages to understand how to create tables in the form.

 

Image001.png

 

There is only one setting for this plug-in, which is to choose which Number field in the App form will have their values automatically set with row numbers. Number fields that exist outside of Tables will not be listed in the drop-down list.

 

tablenumbering_plain.png

 

Save the settings and update the App. When adding new data into a table, the specified Number field will be restricted from being edited. Upon saving the record, the specified Number field will be filled in with their row numbers.

 

sample001.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/
│            └──── icon.png
└── manifest.json

 

config.html

tablenumbering_HTML.png

 

The first "block" contains the HTML of the first settings, where the user chooses which Number field will contain the row number. 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">Row Number</span>
<span class="kintoneplugin-require">*</span>
</label>
<div class="kintoneplugin-row">Please select a Number field that exists in a table.<br />
Row numbers will automatically be placed into this 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>

The drop-down field has an ID allocated to it, which is later specified by the config.js file so that it can be populated with other drop-down choices.

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 drop-down
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');
});
}

This plug-in needs data of the Number fields that exist within Tables from the returned object.
The returned object is passed through 2 for loops - one for identifying fields with type value of SUBTABLE (the Table) and the other for identifying fields within that table with the type value of NUMBER (the Number field). The extracted selections are then appended to the element with the id of select_number_field to create a drop-down list of Number fields (that exist inside tables) in the App.

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

    if (prop.type === 'SUBTABLE') {
        for (var key2 in prop.fields) {
            var field = prop.fields[key2];
            var $option = $('');
        if (field.type === 'NUMBER') {
            $option.attr('value', prop.code + ',' + field.code); //Set table code and number field code
            $option.text(escapeHtml(field.label));
            $('#select_number_field').append($option.clone());
            }
        }
    }
}

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 previously saved any settings before in the plug-in (which are stored using Kintone's setConfig API), then those saved values (the specified Number field) are inserted into the designated plug-in configuration settings.

// Set default values
$('#select_number_field').val(CONF.table_field + ',' + CONF.number_field);

When the Save button is clicked in the plug-in config page, the selected Number field and the related Table data is stored into Kintone using the setConfig API.

config.table_field = number_field.split(',')[0];//Set table field code
config.number_field = number_field.split(',')[1];//Set number field code
kintone.plugin.app.setConfig(config);

 

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 "Numbering Tables" article. 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 config 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 TABLEFIELD = CONFIG.table_field; // Field code of the table
var NUMBERFIELD = CONFIG.number_field; // Field code of number field in the table

There are two main pieces to the desktop.js code.

The first piece is the disabling of the Number fields, so that they cannot be edited by the user.
This process occurs in the app.record.edit.show and app.record.create.show events so that the Number fields are disabled as soon as the user opens the Record Create or Record Edit page. The app.record.edit.change.<fieldcode> and app.record.create.change.<fieldcode> events trigger when a user adds a new row to the table - if these events are not stated, the Number fields in the newly added rows will be editable.

var disableEvents = [
'app.record.edit.show',
'app.record.create.show',
'app.record.edit.change.' + TABLEFIELD,
'app.record.create.change.' + TABLEFIELD
];

When these events are triggered the code looks through the event object, and the disabled property of each Number field in the Table is set to true so that they become un-editable when the event object is returned.

kintone.events.on(disableEvents, function(event){
    var record = event.record;

// Disable number fields in table rows var count = record[TABLEFIELD].value.length; for (var i = 0; i < count; i++) { record[TABLEFIELD].value[i].value[NUMBERFIELD]['disabled'] = true; }; return event; });

 

For the second piece, the Number fields are automatically filled in with row numbers when the app.record.create.submit or app.record.edit.submit event triggers.

// Number table rows at these events
var numberEvents = [
'app.record.create.submit',
'app.record.edit.submit'
];

When these events are triggered, a for loop processes the event object to overwrite the values of the Number fields. Returning this object overwrites the actual data within the Kintone record with the new values set in the event object.

kintone.events.on(numberEvents, function(event) {
    var record = event.record;

    // Auto-number the table rows
    var count = record[TABLEFIELD].value.length;
    for (var i = 0; i < count; i++) {
        record[TABLEFIELD].value[i].value[NUMBERFIELD].value = i + 1;
    }

    return event;
});

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": [
"number_field",
"table_field"
]

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

"name": {
"en": "Table Numbering Plug-in"
},
"description": {
"en": "This sample plug-in automatically adds row numbers to table rows each time the record is saved."
},
"homepage_url": {
"en": "https://developer.kintone.io/hc/en-us/articles/360012420813"
}

 

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!