プログラマーのメモ書き

伊勢在住のプログラマーが気になることを気ままにメモったブログです

kintone の Javascript カスタマイズに関する雑多なあれこれ

kintone の Javascript カスタマイズの際に気がついた、いままで書いてない雑多なことをまとめておきます。

カスタマイズ関連のあれこれは下記にも書いてますので、こちらもご参考にしてください。

スペーステンプレート

スペーステンプレートを利用すると、簡単にスペースおよびそこに含まれるアプリのコピーを作ることができるので、移行の際には非常に便利です。

ただ、スペースやアプリの更新には使えず、常に新規作成になるので アプリ ID (スペース ID)が変わってしまうため、 Javascript カスタマイズとの相性はいまいちですが、まあ、便利です。

ポータルに画像を含む場合

で、このスペーステンプレートを利用して、ポータルが有効なスペースで、かつポータルに画像を設定しているスペースに対して、スペーステンプレートを作成したら、エラーとなったときがありました。

その時の状況としては、

  • 同一ドメインの別スペースで読み込んだ画像を設定しており、その後最初に読み込んだスペースを削除した場合に起きた
  • 詳細は条件は不明だが、アップロードした素材への参照が問題になることがあるようだ
  • エラーになった画像を、再アップロードしてポータルに設定したら問題なく作成できた

という感じでした。

スペーステンプレートを作成する際には、ちょっと気を付けたほうがいいかもしれませんね。

レコードの書き出しと読み込み

アプリを移行する場合、レコードの内容は移されません。なので、別作業で、レコードの書き出しと読み込みを行う必要があるかと思います。

この操作の時に、こんなことに気が付きました。

  • ルックアップのコピーフィールドは、書き出さなくても、読み込み時に適切に対応してくれる(ルックアップ元がある場合)
  • 読み込み時に、『一括更新のキー』として『レコード番号』にチェックがついていると、新規レコードの読み込みに失敗する

最初、2つ目の制限に気がつかなくて、ちょっと焦りました。結局、これは、下記

ファイルからレコードのデータをアプリに読み込む | kintone ヘルプ

のリファレンスの補足にも明記されていることになります。

ということで、アプリを移行するような場合(新規にレコードをコピーするような場合)には、『一括更新のキー』のチェックはなくても問題ないので、チェックを外した設定で読み込めば問題なく取り込めます。

ルックアップと変更イベント

ルックアップ(フィールド)を元に、ルックアップしたら何かしら行いたい、というカスタマイズがあると思います。ですが、ルックアップフィールド自体には、変更イベントが発生しません。

なので、こういう時は、ルックアップ取得時に一緒にコピーするフィールドを用意しておき、そのコピーフィールドに変更イベントを定義して、変更したことを分かるようにすれば対応できます。ちなみに、このコピーフィールドは、変更禁止にしておくとルックアップによる変更イベントのみを発生させて受け取ることができるようになります。

計算フィールドと変更イベント

で、これは聞いた話で自分ではまだ試してないんですが、同様のことが、計算フィールドでも起きるということだそうです(@kimiko0217 さんに教えていただきました)。

まとめ

ある程度カスタマイズしようとすると、こういった kintone の流儀を身に着けておかないと、なかなか効率があがりませんね。きっと、また別のところではまるでしょうが、とりあえずはこんなところで。

何かの参考になれば幸いです。

kintone のテーブルについて

こちらの記事の続きです。

blog.mori-soft.com

今回は、 Javascript カスタマイズに限らず、テーブル周りに関するあれこれをまとめておきます。

グループとテーブル

カスタマイズとはちょっと異なりますが、テーブルはグループに入れられないです。

個人的には、地味にいやな制限です。

テーブルの要素

フォームで新規登録する場合などは、全ての列フィールドが必須でない場合、行の全フィールドが未入力の行があっても、空行が最低1行は入ってしまいます。テーブルの中身が0行というのはフォームで操作する場合は作れないようです。

カスタマイズの時などは、ちょっと意識しておく必要がありますね。

テーブルの行追加・削除の無効化

テーブルに追加したフィールド単位の有効・無効は制御できます。ですが、テーブル全体の無効化はできないみたいです。全部のフィールドを無効にすればいいかな?と思いきや、それでも行の追加ができるので微妙な感じになります。

ネットを調べてみても、テーブル自体を無効(行の追加、削除)にすることはできないっぽいです。

なぜか、公式のドキュメントを見つけらなかったのですが、自分でも試したところ、ダメでした。

どうしてもこれをやりたければ、調べてみると、以下の3つの方法で代替できそうです。

DOM で直接操作

下記などを参考にして、直接 DOM で操作すれば何とかなりそうです。

サブテーブルの追加削除を制限したい - kintone カスタマイズ - cybozu developer community

実際に試してみると、結構簡単に制御できたので、これは使えそうですね。

Kintone UI Component v1 の ReadOnlyTable を使う

テーブル上に情報を表示するだけなら、基本的には関連テーブルでできるんですが、何かの事情でそれができないなら、 ReadOnlyTable を使えば編集不可の情報を表示するだけのテーブルが作れます。

ReadOnlyTable | kintone UI Component · Be a smart kintone developer.

個人的には、これが一番しっくりくる解決策です。

試した際の注意点としては、 ReadOnlyTable のコンストラクタを呼び出すタイミングで、表示したい行データも与えておく必要があります。インスタンス生成後に行データを追加しても画面に反映されませんでした。

Kintone UI Component v1 の Table を使う

Kintone UI Component v1 の Table には、ボタンの追加削除を設定できる actionButton プロパティがあるので、それで制御できるかと思います。

Table | kintone UI Component · Be a smart kintone developer.

既存のレコードは編集させたいが、行の追加・削除はさせたくないという場合は、これもありかと思います。

テーブルの行ごとの更新

テーブルの更新はちょっとややこしいです。

更新時は、更新対象の行だけでなく、その他の行も更新時のリクエストに含める必要があります。

フィールド形式 - cybozu developer network

こちらのリファレンスに

テーブルへの追加、更新時には、既存のすべての行の値を指定してください。

とさらっと書かれている点ですね。リファレンスよりは、下記の解説記事のほうがわかりやすいかもしれません。

レコード更新におけるテーブル操作のテクニック - cybozu developer network

同じページのここのところに、

実際の挙動は「既存の行をすべて削除し、リクエストに含まれるデータをテーブルへ追加する」となります。

とあるように、更新とは言うものの内実は、テーブルの中身を削除して、もう一度追加する、ということのため、このような仕様になっているようです。

なので、更新対象以外の行は、 ID だけでいいので指定する必要があります(変更しないフィールドは含めなくていいというのが、作業的にはちょっとはましなところですかね)。

テーブルの行番号の取得方法

テーブルには行番号という概念がありません。どうしても行番号を表示したければ、行追加時の例の記事、

サブテーブルの追加行を特定したい - kintone カスタマイズ - cybozu developer community

にあるのと同じように、その行が、テーブルの行データ(配列)の何番目に一致するのかを自分で調べてやる必要があります。

ちなみに、テーブルの行に対して、自動で連番を振る、というのが下記で紹介されているので、これを利用する方法もありますね。

テーブルに連番をつける - cybozu developer network

テーブルの行数を取得する

こちらは、フィールドの設定でいけるようです。

テーブルの行数をカウントしたい | kintone ヘルプ

テーブルの行にカウントを設置して、それを計算フィールドで集計すればよいとのことです。

まとめ

テーブル周りは他にもいろいろと落とし穴がありそうです。あんまり使いたくないけど、パッと情報を確認できるのでユーザーからすると便利なんですよね。

もうちょっとテーブル操作用のAPIを用意してくれるとありがたいんですけどねー。

kintone の Javascript カスタマイズのあれこれ

kintone の Javascript カスタマイズをあれこれ触るようになって、気が付いたことをまとめておきます。開発しながらメモった感じなので、間違っていたら、すいません。

REST API の getRecords の limit と totalCount

クエリに該当するレコード数が totalCount で返ってきます。このとき、 limit 指定により取得件数の制限がかけてあり、それが totalCount 以下でも、totalCount = limit にはならずに、 limit を除いたクエリに該当するレコード数になるようです。

APIの説明だと、『クエリに該当するレコード数』とあるので、 limit かけれてば、 totalCount はlimit以下になるように思えるけど、違うので要注意。

クエリの書き方

フィールドコード < 時刻

はありだが、

時刻 < フィールドコード

はエラーになりますので、注意が必要です。

リファレンスはこちら。

クエリの書き方 - cybozu developer network

「フィールドコード 演算子 値」のように記述します。

という表記の通りで、入れ替えては成立しないということです。

レコード更新とレコード番号

複数のレコード更新をする際の updateKey にデフォルトのレコード番号は使えないようです。

複数のレコードを更新する - cybozu developer network

ドキュメントからするとできてもよさそうなんですが、こんな感じのエラーで落ちました。

xxxアプリのyyyでエラーが発生しました。 KintoneRestAPIError: [400] [GAIA_IN06] レコードの更新に失敗しました。「updateKey」に指定したフィールド(code: レコード番号)が不正です。「updateKey」には、文字列(1行)フィールドか数値フィールドのみ指定できます。また、フィールドの設定で、値の重複を禁止する必要があります。 (PviiQ4bCDMEZUl2h4Ull)
    at __webpack_modules__../node_modules/@kintone/rest-api-client/lib/src/KintoneResponseHandler.js.KintoneResponseHandler.handleErrorResponse (d:\work\xxxx\sample_app\node_modules\@kintone\rest-api-client\src\KintoneResponseHandler.ts:49:5)
    at https://localhost:5500/dist/transaction_sample.js:287:123 {name: 'KintoneRestAPIError', id: 'PviiQ4bCDMEZUl2h4Ull', code: 'GAIA_IN06', errors: undefined, status: 400, …}

今回はレコード番号で更新したかったので、仕方なく、次のようにしました。

下記のリファレンスを見ると、レコード番号はレコードIDを含むことは保証されているので、レコード番号からレコードIDを抽出して、それで、更新をかけるのがよさそうです。

フィールド形式 - cybozu developer network

アプリアクション

アプリ間でレコードをコピーしてくれる機能です。

アプリアクションでできること | kintone ヘルプ

便利だけど、こんな制限があります。

  • 同じタイプのフィールド間でしか、コピーできない
  • コピー完了イベント、みたいなものがないので、追加処理を書くようなカスタマイズができない

惜しい!

アプリアクション実行後は、コピー先アプリの新規追加画面が表示されるので、そこでユーザーが保存等の操作するのを前提にして置く必要がありますね。

詳細画面

詳細画面のイベント(app.record.detail.show)からは、 Javascipt API の kintone.app.record.set() を呼び出しても、レコードは更新されません。リファレンスにも明示があります(利用できる画面に含まれていない)。

レコードに値をセットする - cybozu developer network

なので、気が付くまで時間がかかってしまいました。

まあ、レコードの更新を許すと、詳細画面に表示している内容と、書き換えた内容に不一致がでるのでわからなくはないです。

まとめ

カスタマイズ触ってると他にもいろいろと気になる点が出てくると思いますので、折を見てまたまとめたいと思います。