関数を使用した入力規則の作成
関数を使用して入力規則を作成すると、CRMに入力された値を検証し、適切な値のみが保存されるようにできます。また、関数内で特定のパターンを指定することで、電話や郵便番号などのさまざまな項目の値を検証することも可能です。たとえば、パターンが「090-xxxx-xxxx」の値だけを承認できます。関数を使用して入力規則を作成することで、標準機能では検証しづらいパターンも指定することが可能になります。
利用例
ある小売業では、配達業務を外部の物流業者に委託しています。配達物は10桁の参照番号を通じて追跡され、この参照番号は外部の物流業者のデータベースに保存されます。営業担当者がこの参照番号をCRMに入力する際、誤って入力することで、問題が発生したり、配送状況の把握が遅れたりすることがあります。このような問題を防ぐため、参照番号が毎回正しい形式でのみ入力可能になるように設定するとします。この場合、関数を使用して「参照番号」の項目を検証することが可能です。入力規則によって、CRMに登録する値のパターンが、外部の物流業者が指定した参照番号のパターンに一致するかどうかを検証できます。この例では、「AX-」という文字が先頭についた10桁の番号（例：AX-9999999999）が入力された場合のみ、データは保存されます。それ以外の場合は、無効なデータとしてエラーが表示されます。
/* 以下のコードは、CRMから取得した値が保存されている変数（Mapオブジェクト）から項目の一覧とそれぞれの値を取得する例です。この例では、「entityMap」がMapオブジェクトで、項目の値は、該当のMapオブジェクトから取得されます。*/
entityMap = crmAPIRequest.toMap().get('record');
/* 以下は、Mapオブジェクトから項目の値（メールアドレス）を取得するコードの例です。この例では、「entityMap」がMapオブジェクトで、「Email」が項目のAPI名です。
entityMap= {'Email': 'xxx@xxx.com', 'Last_Name': 'xxx'}; */
referenceField= entityMap.get('Reference_Number'); //「Reference_Number」は、「参照番号」の項目のAPI名です。
response = Map();
/* ---------------------------------------------------------------------------------------------- */
こちらにコードを入力して、対象の項目の値を検証します*
/* ---------------------------------------------------------------------------------------------- */
/*入力した値がコードで指定した条件と一致しない場合は、エラーのステータスを設定し、通知メッセージを表示します：*/
if(referenceField.matches('[A-Z]{3}-[0-9]{10}')) {
response.put('status','error');
response.put('message', 'Invalid Reference Number');
} else {
/*検証によるエラーがない場合は、処理完了のステータスを設定します：*/
response.put('status','success');
}
}
/* ---------------------------------------------------------------------------------------------- */
return response.toString();
メモ
- 関数を作成することにより、標準的な条件のみを使用した検証（条件基準の入力規則）の代わりに、関数で指定した任意のパターンを使用した検証（関数基準の入力規則）を設定できます。
- 作成可能な入力規則の上限は、利用するプランによって異なります。タブごとに設定可能なルールや規則の合計数のうち、エンタープライズプランでは、関数を使用した入力規則を3件まで作成できます。アルティメットプランでは5件まで作成できます。それぞれのプランで設定可能なルールや規則の上限については、各プランの機能と制限のページをご参照ください。
- 条件基準の入力規則で使用できる項目のみ、関数基準の入力規則で使用できます。
- 項目に値が入力されていない場合、関数が正しく機能しません。関数を正しく機能させるには、項目に値が入力されていることをご確認ください。
- 関数による出力値は、上記のサンプルコードで指定したものと同様の値にする必要があります。指定した出力値以外の値は、無効として判断されエラーが表示されます。
- 関数内の項目の値は、APIの形式の値のみ使用できます。項目の値にアクセスするには、項目のAPI名を使用します。
- Zoho CRMのモバイルアプリでも、入力規則を適用できます。ただし、モバイルアプリでは入力規則を作成することはできません。
- 関数の実行に失敗した場合は、エラーメッセージが表示されます。考えられる原因として、次の点をご確認ください：
- コードが正しく入力されているかどうか
- 関数の実行時間が長すぎないかどうか
- 問題が解決しない場合は、support@zohocrm.comにご連絡ください。
関数による入力規則を作成するには
- 画面左側のメニューで対象のタブにカーソルを合わせ、［…］（その他の操作）アイコンをクリックし、［入力規則］を選択します。
または、［設定］→［カスタマイズ］→［タブと項目］の順に移動し、タブの一覧で、入力規則を作成する対象のタブをクリックします。タブの設定画面で、［入力規則］タブをクリックし、［新しい入力規則を作成する］をクリックします。 - ［入力規則を作成する］画面で、以下の操作を実行します。
- 対象のレイアウトを選択します。
- 検証する対象の項目を選択します。
- 検証の種類の選択欄で［関数を使用］を選択します。
- 入力規則による検証の実行タイミングの設定欄で、［データの保存時のみ］または［項目の検証時とデータの保存時］（項目ごとの検証ボタンのクリック時とデータの保存時の両方）のいずれかを選択します。
- ［次へ］をクリックします。
- ［関数の設定］画面で、次のいずれかの手順を実行します：
- ［関数］を選択します。［関数を選択］クリックして、表示された画面で対象の関数を選択し、［設定する］をクリックして設定した後、［保存する］をクリックします。
- ［自分で作成する］を選択します。関数名と表示名を入力して［作成］をクリックし、編集画面で関数の詳細を設定した後、［保存する］をクリックします。
- 画面右上にある［保存する］をクリックして、入力規則を保存します。
メモ
入力規則用の関数を作成するには：
- ［設定］→［開発者向け情報］→［関数］→［+ 新しい関数］の順に移動します。
- ［カテゴリー］で、メニューから［入力規則］を選択します。