context.AddMessage
概要¶
サーバスクリプトでブラウザの下部にメッセージを出力するメソッドです。複数回実行すると複数のメッセージを出力します。
構文¶
パラメータ¶
| パラメータ | 型 | 必須 | 概要 |
|---|---|---|---|
| message | string | ○ | メッセージ |
| css | string | CSSクラス名 |
戻り値¶
戻り値はありません。
使用例¶
下記の例では、組織ID 3 のユーザが状況項目が完了の場合にメッセージを出力します。
JavaScript¶
CSSクラス名¶
下記のCSSクラス名が使用できます。独自のCSSを作成し割り当てることも可能です。
| CSSクラス名 | スタイル |
|---|---|
| alert-information | 青の背景で情報を表します |
| alert-warning | 黄色の背景で警告を表します |
| alert-success | 緑の背景で警告を表します |
| alert-error | 赤の背景でエラーを表します |
サンプルコード¶
1. 完了にしたとき、保存は止めずに入力漏れと予定との差を知らせる
タスク管理のテーブルで、状況を「完了」にして更新したとき、保存は止めずに、実績工数の入力漏れや、予定工数との差をcontext.AddMessageでメッセージに出します。実績工数が空のときは黄色の警告、予定工数の1.2倍を超えたときは青の知らせを出します。
実務での使いどころ¶
実績工数の入力漏れは、工数の集計や見積の振り返りを狂わせます。項目の入力検証などで必須にすると、未入力のまま完了にできなくなり、現場の作業が止まります。このサンプルでは、完了の操作はそのまま通し、更新したその画面で入力漏れや予定との差を知らせます。保存を止めたいときはcontext.Errorを使います。
事前準備¶
1:「タスク管理」テーブル(期限付きテーブル)で、以下の項目を有効化してください。
| 項目コード | 内容 |
|---|---|
| 数値A(NumA) | 実績工数 |
| 数値B(NumB) | 予定工数 |
2:スクリプトを登録します。
2-1:「テーブルの管理 > サーバスクリプト」タブで「新規作成」を選択する。
2-2:タイトル: 任意の名前(例:noticeOnComplete)
2-3:スクリプト: 下記サンプルコードを貼り付け
2-4:条件: 「更新前」にチェック
JavaScript¶
// 完了の状況の値
const COMPLETED_STATUS = 900;
// 実績工数が予定工数のこの倍率を超えたら知らせる
const OVER_RATE = 1.2;
// 状況を完了にして更新するとき、保存は止めずに、入力漏れや予定との差をメッセージで知らせる
function noticeOnComplete() {
if (model.Status !== COMPLETED_STATUS) {
return;
}
const actual = model.NumA; // 実績工数
const planned = model.NumB; // 予定工数
if (!actual) {
context.AddMessage('実績工数が未入力のまま完了にしました。実績工数を入力して、もう一度更新してください。', 'alert-warning');
return;
}
if (planned && actual > planned * OVER_RATE) {
context.AddMessage(
`実績工数(${actual}時間)が予定工数(${planned}時間)を2割以上超えています。原因を内容欄に残してください。`,
'alert-information'
);
}
}
noticeOnComplete();
注記¶
- メッセージを出しても、保存は止まりません。標準の「更新しました」の下に並んで表示されます。
- 「作成前」でも
context.AddMessageは呼べますが、作成のあとは編集画面へ切り替わるため、メッセージは消えます。このサンプルの条件は「更新前」のみにしています。 - 実績工数が 0 のときも、未入力として扱います。
2. 受注の金額を下げた・納期を動かしたとき、前の値との差を知らせる
受注管理のテーブルで更新したとき、データベースにある前の値(saved)とこれから保存する値(model)を比べ、保存は止めずにcontext.AddMessageで知らせます。受注金額を下げたときは減額分を、納期を前倒ししたときは早めた日数を黄色の警告で出します。納期を延ばしたときは、延ばした日数を青の知らせで出します。
実務での使いどころ¶
受注後の値引きには承認、納期の前倒しには手配の確認、延期には取引先への連絡が要りますが、更新した本人が気付かずに進めてしまうことがあります。標準の通知では、変わったことを関係者に知らせられますが、前の値より下がった・早まったという向きで分けることはできません。このサンプルでは、変えたその画面で、何をどのくらい変えたかと、次にすることを知らせます。
事前準備¶
1:「受注管理」テーブル(期限付きテーブル)で、以下の項目を有効化してください。
| 項目コード | 内容 |
|---|---|
| 数値A(NumA) | 受注金額 |
| 日付A(DateA) | 納期 |
2:スクリプトを登録します。
2-1:「テーブルの管理 > サーバスクリプト」タブで「新規作成」を選択する。
2-2:タイトル: 任意の名前(例:noticeOnAmountOrDueChange)
2-3:スクリプト: 下記サンプルコードを貼り付け
2-4:条件: 「更新前」にチェック
JavaScript¶
// 1日のミリ秒
const DAY_MS = 24 * 60 * 60 * 1000;
// 金額を前の値と比べ、下げたときだけ知らせる(空・0のときは比べない)
function noticeAmount(before, after) {
if (!before || !after || after >= before) {
return;
}
context.AddMessage(
`受注金額を${before.toLocaleString()}円から${after.toLocaleString()}円に下げました(${(before - after).toLocaleString()}円の減額)。値引きの承認を確かめてください。`,
'alert-warning'
);
}
// 納期を前の値と比べ、早めた・延ばした日数を知らせる(どちらかが空のときは比べない)
function noticeDue(before, after) {
if (!utilities.InRange(before) || !utilities.InRange(after)) {
return;
}
const days = Math.round((new Date(after) - new Date(before)) / DAY_MS);
if (days < 0) {
context.AddMessage(`納期を${-days}日前倒ししました。手配が間に合うか確かめてください。`, 'alert-warning');
} else if (days > 0) {
context.AddMessage(`納期を${days}日延ばしました。取引先へ連絡してください。`, 'alert-information');
}
}
// 更新するとき、保存は止めずに、前の値(saved)との差をメッセージで知らせる
function noticeOnAmountOrDueChange() {
noticeAmount(Number(saved.NumA), Number(model.NumA)); // 受注金額
noticeDue(saved.DateA, model.DateA); // 納期
}
noticeOnAmountOrDueChange();
注記¶
savedは「更新前」の条件でのみ前の値を持つため、条件は「更新前」のみにしています。新規作成のときは何も出しません。- 受注金額は、前後のどちらかが空か 0 のときは比べません。納期は、前後のどちらかが空のときは比べません。
- 金額と納期を同時に変えたときは、メッセージが 2 つ並んで表示されます。メッセージを出しても、保存は止まりません。
- 関係者へ自動で知らせたいときは、標準の通知(変更を監視する項目)と組み合わせてください。
