kintone plugin series
計算式ドキュメント
Boost! ActionやBoost! Upsertには計算式(関数)の結果をフィールドに入力する機能がございます。
このページではどのような関数が使用出来るかをご説明致しますので、状況に応じご利用頂けますと幸いです。
複数選択が可能なフィールドの取り扱いについて
-
フィールド値から文字列への変換
チェックボックスやユーザー選択フィールドのように複数選択可能なフィールドについては、それらの値を自動的にカンマ区切りの文字列に変換した後に処理を行いますので、関数の引数にそれらフィールドを利用する場合は参考にして下さい。
チェックボックス
複数選択選択済みの値をカンマ区切りの文字列に変換します。 例)
"sample1,sample2"
ユーザー選択 ユーザー名をカンマ区切りの文字列に変換します。 例)
"Noboru Sato,Misaki Kato"
組織選択 組織名をカンマ区切りの文字列に変換します。 例)
"Development Department,Human Resources Department"
グループ選択 グループ名をカンマ区切りの文字列に変換します。 例)
"Managers,Leaders"
作業者 作業者名をカンマ区切りの文字列に変換します。 例)
"Noboru Sato,Misaki Kato"
作成者 作成者名に変換します。 例)
"Creator"
更新者 更新者名に変換します。 例)
"Modifier"
-
それぞれのフィールド形式に合わせた文字列
チェックボックスやユーザー選択フィールドのように複数選択可能なフィールドについては、固定値であっても計算の結果であっても、最終的に文字列からそれぞれのフィールド形式に沿ったデータ形に変換する必要があるので、それに合わせた文字列の形式に整形する必要があります。
チェックボックス
複数選択固定値もしくは計算結果の値として、カンマ区切りの文字列に整形します。 例)
"sample1,sample2"
ユーザー選択 固定値もしくは計算結果の値として、「ログイン名:表示名」の順序でカンマ区切りにした文字列に整形します。 例)
"sato:Noboru Sato,kato:Misaki Kato"
組織選択 固定値もしくは計算結果の値として、「組織コード:組織名」の順序でカンマ区切りにした文字列に整形します。 例)
"dev:Development Department,hr:Human Resources Department"
グループ選択 固定値もしくは計算結果の値として、「グループコード:グループ名」の順序でカンマ区切りにした文字列に整形します。 例)
"mgr:Managers,ldr:Leaders"
関数の引数にフィールドを指定する場合
関数の引数にフィールドを指定して、その値を利用する場合は、利用したいフィールドのフィールドコードをパーセント記号で囲って指定して下さい。
例)
フィールドコードが「日付1」の日付フィールドの値に該当する処理実行時の年齢を返す。
AGE(%日付1%)
文字列の結合について
文字列や関数の戻り値を結合した結果をフィールドに渡したい場合は、それらの文字列や関数の戻り値を「+」で繋ぎます。
例)
数値1フィールドの値を文字列に変換し、他の文字列を結合した結果を返す。
"ABC"+TO_STRING(%数値1%)
関数一覧
- IF
-
IF関数を使用すると、設定した条件式に従って、出力する値を変化させることが出来ます。
-
入力方法
IF(条件式,真の場合,偽の場合)
-
引数
条件式判断したいフィールドの値や固定値または関数の結果値を、比較演算子を用いて比べます。真の場合条件式が正の場合の出力内容(固定値/関数の結果値/数値演算)を指定します。偽の場合条件式が偽の場合の出力内容(固定値/関数の結果値/数値演算)を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
数値1フィールドが100より大きければ「1」、それ以外は「0」を返す。
IF(%数値1%>100,1,0) -
比較演算子について
=文字列または数値の値が等しければ真、等しくなければ偽を返します。!=「=」の比較結果を反転させたものになります。<左の値が右の値より小さければ真、右の値以上であれば偽を返します。<=左の値が右の値以下であれば真、右の値より大きければ偽を返します。>左の値が右の値より大きければ真、右の値以下であれば偽を返します。>=左の値が右の値以上であれば真、右の値より小さければ偽を返します。
-
- LIKE
-
IF関数の条件式において、指定した文字列の中に検索値が含まれているかどうかを判断する際に利用します。
-
入力方法
LIKE(検索対象の文字列,検索する文字列)
-
引数
検索対象の文字列フィールドコード/固定値/関数の結果値のいずれかを指定します。検索する文字列フィールドコード/固定値/関数の結果値のいずれかを指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
文字列1フィールドの中に"ABC"が含まれていれば「1」、それ以外は「0」を返す。
IF(LIKE(%文字列1%,"ABC"),1,0)
-
- AND
-
IF関数の条件式において、全ての条件を満たすかどうかを判断する際に利用します。
-
入力方法
AND(条件式1,条件式2,...)
-
利用例
数値1フィールドが100より大きく、文字列1フィールドが"ABC"であれば「1」、それ以外は「0」を返す。
IF(AND(%数値1%>100,%文字列1%="ABC"),1,0)
-
- OR
-
IF関数の条件式において、いずれかの条件を満たすかどうかを判断する際に利用します。
-
入力方法
OR(条件式1,条件式2,...)
-
利用例
数値1フィールドが100より大きいか、文字列1フィールドが"ABC"であれば「1」、それ以外は「0」を返す。
IF(OR(%数値1%>100,%文字列1%="ABC"),1,0)
-
- TO_NUMBER
-
TO_NUMBER関数を使用すると、フィールド値や関数の結果値を文字列から数値に変換することが出来ます。
-
入力方法
TO_NUMBER(%フィールドコード%または関数の結果値)
-
引数
フィールドコードまたは関数変換元となる値が入力されているフィールドコードまたは関数の結果値を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
変換元の値の中に数値以外の値が入っている場合は0が返ります。
-
利用例
文字列1フィールドの値を数値に変換し、2を乗算した結果を返す。
TO_NUMBER(%文字列1%)*2
-
- TO_STRING
-
TO_STRING関数を使用すると、フィールド値や関数の結果値を数値から文字列に変換することが出来ます。
-
入力方法
TO_STRING(%フィールドコード%または関数の結果値)
-
引数
フィールドコードまたは関数変換元となる値が入力されているフィールドコードまたは関数の結果値を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
数値1フィールドの値を文字列に変換し、他の文字列を結合した結果を返す。
"ABC"+TO_STRING(%数値1%)
-
- TODAY
-
TODAY関数を使用すると、処理実行時の日付を取得することが出来ます。
-
入力方法
TODAY()
-
- NOW
-
NOW関数を使用すると、処理実行時の日時を取得することが出来ます。
-
入力方法
NOW()
-
- AGE
-
AGE関数を使用すると、指定した日付に該当する処理実行時の年齢を取得することが出来ます。
-
入力方法
AGE(%フィールドコード%または関数の結果値)
-
引数
フィールドコードまたは関数計算元となる日付値が入力されているフィールドコードまたは関数の結果値を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
日付1フィールドの値に該当する処理実行時の年齢を返す。
AGE(%日付1%)
-
- ASC
-
ASC関数を使用すると、文字列に含まれた全角英数カナを半角に変換することが出来ます。
-
入力方法
ASC(%フィールドコード%または関数の結果値)
-
引数
フィールドコードまたは関数変換元となる値が入力されているフィールドコードまたは関数の結果値を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
文字列1フィールドの値に含まれた全角英数カナを半角に変換した結果を返す。
ASC(%文字列1%)
-
- DATE_CALC
-
DATE_CALC関数を使用すると、指定した内容で日付計算を実行することが出来ます。
-
入力方法
DATE_CALC(%フィールドコード%または関数の結果値,"計算パターン(加算減算値 単位)")
-
引数
フィールドコードまたは関数計算元となる日付値が入力されているフィールドコードまたは関数の結果値を指定します。計算パターン(加算減算値)計算元の値に対し加算減算を行う数値を指定します。
固定値の代わりにフィールドコードも指定可能計算パターン(単位)加算減算の単位を指定します。
年year 月month 日day 時hour 分minute 年初first-of-year 月初first-of-month 週初first-of-week 年初・月初・週初の場合は加算減算値の入力は不要です。フィールドコードはパーセント記号で、計算パターンはダブルクォーテーションで囲むようにして下さい。
計算パターンの加算減算値と単位の間には半角スペースを入れて下さい。
複数のパターンで計算を行いたい場合は、各パターンをカンマで区切って下さい。
-
利用例
日付1フィールドを基準にその2ヶ月前の日付を返す。
DATE_CALC(%日付1%,"-2 month")日付1フィールドを基準にその月末の日付を返す。
DATE_CALC(%日付1%,"first-of-month,1 month,-1 day")日付1フィールドを基準に数値1フィールド分加算した日付を返す。
DATE_CALC(%日付1%,"%数値1% day")日付1フィールドを基準にその週初から10日後の日付を返す。
DATE_CALC(%日付1%,"first-of-week,10 day")
-
- DATE_DIFF
-
DATE_DIFF関数を使用すると、指定した期間の経過日数を取得することが出来ます。
-
入力方法
DATE_DIFF(%開始日フィールド%,%終了日フィールド%または"TODAY","表示形式")
-
引数
開始日フィールド期間の最初の日付が入力されているフィールドコードまたは関数の結果値を指定します。終了日フィールド期間の最後の日付が入力されているフィールドコードまたは関数の結果値を指定します。
当日日付との経過日数を取得したい場合は「TODAY」と入力表示形式表示形式を指定します。
年Y 月M (この表示形式には経過年以降の残月数が入ります) FM (この表示形式には経過期間の総月数が入ります) 日D (この表示形式には経過月以降の残日数が入ります) FD (この表示形式には経過期間の総日数が入ります) 当日日付との経過日数を取得したい場合は「TODAY」と入力例)
年と月で経過日数を表示
Y年Mヶ月年と月と残日数で経過日数を表示
Y年Mヶ月とD日フィールドコードはパーセント記号で、表示形式はダブルクォーテーションで囲むようにして下さい。
-
利用例
日付1フィールドを開始日に、日付2フィールドを終了日とし、年と月の表示形式に変換した文字列を返す。
DATE_DIFF(%日付1%,%日付2%,"Y年Mヶ月")日付1フィールドを開始日に、当日を終了日とし、年と月と残日数の表示形式に変換した文字列を返す。
DATE_DIFF(%日付1%,"TODAY","Y年Mヶ月D日")
-
- DATE_FORMAT
-
DATE_FORMAT関数を使用すると、指定した形式で日付を文字列にすることが出来ます。
-
入力方法
DATE_FORMAT(%フィールドコード%または関数の結果値,"表示形式")
-
引数
フィールドコードまたは関数計算元となる日付値が入力されているフィールドコードまたは関数の結果値を指定します。表示形式表示形式を指定します。
年Y 月m (ゼロ埋めの2桁) 日d (ゼロ埋めの2桁) 時H (ゼロ埋めの2桁) 分i (ゼロ埋めの2桁) 年月日時分のそれぞれを組み合わせて表示出来ます。例)
年と月をハイフンで繋いで表示。
Y-m時と分をコロンで繋いで表示。
H:iフィールドコードはパーセント記号で、表示形式はダブルクォーテーションで囲むようにして下さい。
-
利用例
日付1フィールドの値を年月日の表示形式に変換した文字列を返す。
DATE_FORMAT(%日付1%,"Y-m-d")現在時刻を時分の表示形式に変換した文字列を返す。
DATE_FORMAT(NOW(),"H:i")
-
- DATE_STRING
-
DATE_STRING関数を使用すると、指定した日付に該当する和暦を取得することが出来ます。
-
入力方法
DATE_STRING(%フィールドコード%または関数の結果値)
-
引数
フィールドコードまたは関数計算元となる日付値が入力されているフィールドコードまたは関数の結果値を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
日付1フィールドの値を和暦に変換した文字列を返す。
DATE_STRING(%日付1%)
-
- LPAD
-
LPAD関数を使用すると、結果の文字列が指定した長さになるように、現在の文字列の左側から他の文字列で埋めることが出来ます。
-
入力方法
LPAD(%フィールドコード%または関数の結果値,文字列の長さ,埋めるための文字)
-
引数
フィールドコードまたは関数変換元となる値が入力されているフィールドコードまたは関数の結果値を指定します。文字列の長さ結果として取得したい文字数を指定します。埋めるための文字指定した長さまで埋めるための文字を指定します。フィールドコードはパーセント記号で、埋めるための文字はダブルクォーテーションで囲むようにして下さい。
-
利用例
数値1フィールドの値を10桁になるまで0で埋めた結果を返す。
LPAD(%数値1%,10,"0")
-
- RPAD
-
RPAD関数を使用すると、結果の文字列が指定した長さになるように、現在の文字列の右側から他の文字列で埋めることが出来ます。
-
入力方法
RPAD(%フィールドコード%または関数の結果値,文字列の長さ,埋めるための文字)
-
引数
フィールドコードまたは関数変換元となる値が入力されているフィールドコードまたは関数の結果値を指定します。文字列の長さ結果として取得したい文字数を指定します。埋めるための文字指定した長さまで埋めるための文字を指定します。フィールドコードはパーセント記号で、埋めるための文字はダブルクォーテーションで囲むようにして下さい。
-
利用例
数値1フィールドの値を10桁になるまで0で埋めた結果を返す。
RPAD(%数値1%,10,"0")
-
- LEFT
-
LEFT関数を使用すると、文字列の左側から指定文字数分の文字列を取得することが出来ます。
-
入力方法
LEFT(%フィールドコード%または関数の結果値,切り出し文字数)
-
引数
フィールドコードまたは関数変換元となる値が入力されているフィールドコードまたは関数の結果値を指定します。切り出し文字数切り出す文字数を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
文字列1フィールドの値を左側から5文字切り出した結果を返す。
LEFT(%文字列1%,5)
-
- RIGHT
-
RIGHT関数を使用すると、文字列の右側から指定文字数分の文字列を取得することが出来ます。
-
入力方法
RIGHT(%フィールドコード%または関数の結果値,切り出し文字数)
-
引数
フィールドコードまたは関数変換元となる値が入力されているフィールドコードまたは関数の結果値を指定します。切り出し文字数切り出す文字数を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
文字列1フィールドの値を右側から5文字切り出した結果を返す。
RIGHT(%文字列1%,5)
-
- MID
-
MID関数を使用すると、指定位置から指定文字数分の文字列を取得することが出来ます。
-
入力方法
MID(%フィールドコード%または関数の結果値,切り出し開始位置,切り出し文字数)
-
引数
フィールドコードまたは関数変換元となる値が入力されているフィールドコードまたは関数の結果値を指定します。切り出し開始位置切り出しを開始する文字位置を指定します。 (開始インデックスは1)切り出し文字数切り出す文字数を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
文字列1フィールドの値を3文字目から5文字切り出した結果を返す。
MID(%文字列1%,3,5)
-
- REPLACE
-
REPLACE関数を使用すると、文字列を他の文字列に置き換えることが出来ます。
-
入力方法
REPLACE(%フィールドコード%または関数の結果値,"検索文字列","置換文字列")
-
引数
フィールドコードまたは関数置換元となる値が入力されているフィールドコードまたは関数の結果値を指定します。検索文字列検索する文字列を指定します。 (正規表現も指定可能)置換文字列置き換える文字列を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
文字列1フィールドの値の中に「株式会社」が入っていれば、それを「有限会社」に変更した結果を返す。
REPLACE(%文字列1%,"株式会社","有限会社")
-
- LEN
-
LEN関数を使用すると、文字列の文字数を取得することが出来ます。
-
入力方法
LEN(%フィールドコード%または関数の結果値)
-
引数
フィールドコードまたは関数取得元となる値が入力されているフィールドコードまたは関数の結果値を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
文字列1フィールドの値の文字数を返す。
LEN(%文字列1%)
-
- LENB
-
LENB関数を使用すると、文字列のバイト数を取得することが出来ます。
-
入力方法
LENB(%フィールドコード%または関数の結果値)
-
引数
フィールドコードまたは関数取得元となる値が入力されているフィールドコードまたは関数の結果値を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
文字列1フィールドの値のバイト数を返す。
LENB(%文字列1%)
-
- LINES
-
LINES関数を使用すると、文字列複数行の指定行の文字列のみを取得することが出来ます。
-
入力方法
LINES(%フィールドコード%または関数の結果値,取得行番号)
-
引数
フィールドコードまたは関数取得元となる値が入力されているフィールドコードまたは関数の結果値を指定します。取得行番号取得したい行位置(行番号)を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
-
利用例
文字列複数行1フィールドの値の3行目の文字列を返す。
LINES(%文字列複数行1%,3)
-
- LOOP
-
LOOP関数を使用すると、指定したテーブルの各行に対して、値の生成(固定文字列、関数、計算式)を繰り返し、その結果を新しい複数行の文字列として取得することが出来ます。
-
入力方法
LOOP(%フィールドコード%,/*計算式*/,取得対象行限定の為の真偽値)
-
引数
フィールドコード取得元となるテーブルのフィールドコードを指定します。計算式値の生成を行う為の、固定文字列や関数そして計算式を指定します。計算式は「/*」「*/」で囲うようにして下さい。
計算式の中で改行する場合は、改行位置に「\\n」を挿入して下さい。
取得対象行限定の為の真偽値動作条件にテーブル内フィールドを措定し、その値に該当するテーブル行のみを取得対象とする場合は「true」を指定します。フィールドコードはパーセント記号で囲むようにして下さい。
-
利用例
フィールドコードが「テーブル1」のテーブルの各行に対して、そのテーブル内のフィールド(文字列1フィールドと数値1フィールド)で値の生成を行い、複数行の文字列を返す
LOOP(%テーブル1%,/*"Item: "+%文字列1%+"\\nQuantity: "+TO_STRING(%数値1%)+"\\n"*/)
結果値»
Item: Orange
Quantity: 10
Item: Apple
Quantity: 15
Item: Kiwi
Quantity: 5次の利用例はBoost! Actionに関する利用例です。
テーブル内のラジオボタンの値が特定の値である時という動作条件を指定し、その条件に該当する行で新しい複数行の文字列を返す
LOOP(%テーブル1%,/*"String: "+%文字列1%+"\\nNumber: "+TO_STRING(%数値1%)+"\\n"*/,true)
-
- MATH
-
MATH関数を使用すると、指定した計算式からその結果を取得することが出来ます。
-
入力方法
MATH(計算式)
-
引数
計算式フィールドの値を計算式に組み込む場合はパーセント記号で囲ったフィールドコードで指定して下さい。 -
利用可能な演算子
+加算-減算*乗算/除算**べき乗 -
利用例
数値1フィールドに「2」を加算した結果を返す。
MATH(%数値1%+2)数値1フィールドを数値2フィールドで除算した結果を返す。
MATH(%数値1%/%数値2%)
-
- MAX
-
MAX関数を使用すると、指定したテーブル内フィールドの最大値を取得することが出来ます。
-
入力方法
MAX(%フィールドコード%,取得対象行限定の為の真偽値)
-
引数
フィールドコード取得元となる数値または日付が入力されているテーブル内のフィールドコードを指定します。取得対象行限定の為の真偽値動作条件にテーブル内フィールドを措定し、その値に該当するテーブル行のみを取得対象とする場合は「true」を指定します。フィールドコードはパーセント記号で囲むようにして下さい。
-
利用例
数値1フィールドに含まれている最大値を取得し、1を加算した結果を返す。
MAX(%数値1%)+1次の利用例はBoost! Actionに関する利用例です。
数値1フィールドが属するテーブル内のラジオボタンの値が特定の値である時という動作条件を指定し、その条件に該当する行範囲に含まれている最大値に1を加算した結果を返す。
MAX(%数値1%,true)+1
-
- MIN
-
MIN関数を使用すると、指定したテーブル内フィールドの最小値を取得することが出来ます。
-
入力方法
MIN(%フィールドコード%,取得対象行限定の為の真偽値)
-
引数
フィールドコード取得元となる数値または日付が入力されているテーブル内のフィールドコードを指定します。取得対象行限定の為の真偽値動作条件にテーブル内フィールドを措定し、その値に該当するテーブル行のみを取得対象とする場合は「true」を指定します。フィールドコードはパーセント記号で囲むようにして下さい。
-
利用例
数値1フィールドに含まれている最小値を取得し、1を減算した結果を返す。
MIN(%数値1%)-1次の利用例はBoost! Actionに関する利用例です。
数値1フィールドが属するテーブル内のラジオボタンの値が特定の値である時という動作条件を指定し、その条件に該当する行範囲に含まれている最小値に1を減算した結果を返す。
MIN(%数値1%,true)-1
-
- ROWS
-
ROWS関数を使用すると、指定したテーブルの行数を取得することが出来ます。
-
入力方法
ROWS(%フィールドコード%,取得対象行限定の為の真偽値)
-
引数
フィールドコード取得元となるテーブルのフィールドコードを指定します。取得対象行限定の為の真偽値動作条件にテーブル内フィールドを措定し、その値に該当するテーブル行のみを取得対象とする場合は「true」を指定します。フィールドコードはパーセント記号で囲むようにして下さい。
-
利用例
テーブルの行数を返す。
ROWS(%テーブル%)次の利用例はBoost! Actionに関する利用例です。
テーブル内のラジオボタンの値が特定の値である時という動作条件を指定し、その条件に該当するテーブルの行数を返す。
ROWS(%テーブル%,true)
-
- WEEK_CALC
-
WEEK_CALC関数を使用すると、指定した日付の曜日インデックスを取得することが出来ます。
-
入力方法
WEEK_CALC(%フィールドコード%または関数の結果値)
-
引数
フィールドコードまたは関数計算元となる日付値が入力されているフィールドコードまたは関数の結果値を指定します。フィールドコードはパーセント記号で、固定値はダブルクォーテーションで囲むようにして下さい。
取得される曜日インデックスは日曜日が「0」土曜日が「6」となります。
-
利用例
日付1フィールドの値の曜日インデックスを返す。
WEEK_CALC(%日付1%)
-
料金
Boost!シリーズのプラグインはすべて無料でダウンロードして使用できますが、3ヶ月の試用期間を過ぎると、インストールしているアプリ毎に1日1回、ライセンス購入を促すメッセージが表示されます。このメッセージを表示させずに利用する為には、年額10,000円をお支払頂く必要があります。
Boost!はドメインライセンスになりますので、ユーザー数に上限はありません。
個々の製品単位ではなく、Boost!シリーズ全体としてのライセンスであり料金になります。