コンテンツにスキップ

items.BulkDelete

概要

指定したサイトのレコードを一括削除します。選択条件を指定して削除対象のレコードを絞り込むことができます。

構文

items.BulkDelete(siteId, data)

パラメータ

パラメータ 型 必須 概要
siteId long ○ 対象テーブルのサイトIDを指定。
data string ○ 一括削除するレコードの条件等をJSON形式で指定。JSONの仕様は レコード一括削除API の「設定値」を参照。

戻り値

一括削除したレコード数を返却します。削除できなかった場合は0を返却します。

使用例 1

以下の例では、サイトID 123 のテーブルにある Status(状況) が 900(完了) のレコードを削除します。

JavaScript
let data = {
    View: {
        ColumnFilterHash: {
            Status: "[900]"
        }
    }
};
items.BulkDelete(123, JSON.stringify(data));

使用例 2

以下の例では、サイトID 123 のテーブルにある レコードIDが 1000,1003,1400のレコードを削除します。

JavaScript
let data = {
    Selected: [1000,1003,1400]
};
items.BulkDelete(123, JSON.stringify(data));

使用例 3

以下の例では、サイトID 123 のテーブルにある全レコードを削除します。

JavaScript
let data = {
    All: true
};
items.BulkDelete(123, JSON.stringify(data));

サンプルコード

1. 案件を削除したとき、その案件の作業明細をまとめて削除する

案件管理のテーブルで案件を削除したあと、作業明細のテーブルに残っている、その案件の明細をitems.BulkDeleteでまとめて削除します。

実務での使いどころ

案件と作業明細、受注と出荷明細のように、親のレコードに明細がぶら下がる構成で、親を削除したあとも明細が残り続けるのを防げます。標準の機能には、あるテーブルのレコードの削除に合わせて、別のテーブルのレコードを削除する仕組みがありません。明細を1件ずつitems.Deleteで削除するのと違い、1回の呼び出しでまとめて削除できます。

事前準備

1:「作業明細」テーブル(記録テーブル)で、以下の項目を有効化してください。

項目コード 内容
タイトル(Title) 作業内容
分類A(ClassA) 親の案件ID。案件管理テーブルへのリンクでも、自由入力でもかまいません

あわせて「テーブルの管理 > 全般」タブの「サイト名」に「作業明細」と入力してください。サンプルコードはこのサイト名で「作業明細」テーブルを探します。

2:「案件管理」テーブルにスクリプトを登録します。

2-1:「テーブルの管理 > サーバスクリプト」タブで「新規作成」を選択する。
 2-2:タイトル: 任意の名前(例:deleteDetailsWithParent)
 2-3:スクリプト: 下記サンプルコードを貼り付け
 2-4:条件: 「削除後」にチェック

JavaScript
// 作業明細テーブルの「サイト名」(テーブルの管理 > 全般 で設定する)
const DETAIL_SITE_NAME = '作業明細';
// 作業明細で、親の案件IDを持つ項目
const PARENT_ID_COLUMN = 'ClassA';

// 案件を削除したあと、その案件の作業明細をまとめて削除する
function deleteDetails() {
    const detailSite = items.GetClosestSite(DETAIL_SITE_NAME);
    if (!detailSite) {
        logs.LogUserError(
            `[deleteDetailsWithParent] サイト名「${DETAIL_SITE_NAME}」のサイトが見つからないため削除をスキップします`,
            'main',
        );
        return;
    }
    // 「削除後」では、context.Id に削除したレコードのIDが入る
    const parentId = String(context.Id);
    // 分類項目は、配列形式+ExactMatchMultipleで完全一致で絞り込む(view.SearchTypes の表で、分類項目のどの形式にも指定できる検索方法)
    const view = {
        View: {
            ColumnFilterHash: { [PARENT_ID_COLUMN]: `["${parentId}"]` },
            ColumnFilterSearchTypes: { [PARENT_ID_COLUMN]: 'ExactMatchMultiple' },
        },
    };
    const candidates = Array.from(items.Get(detailSite.SiteId, JSON.stringify(view)));
    // 削除は取り消せないため、値が完全に一致するレコードだけを選び、IDで指定して削除する
    const targetIds = candidates
        .filter((item) => String(item[PARENT_ID_COLUMN]) === parentId)
        .map((item) => item.ResultId);
    logs.LogInfo(
        `[deleteDetailsWithParent] 案件ID=${parentId} 候補${candidates.length}件 削除対象${targetIds.length}件`,
        'main',
    );
    // 0件のまま呼ばない(Selected が空の指定を避ける)
    if (targetIds.length === 0) {
        return;
    }
    const count = items.BulkDelete(detailSite.SiteId, JSON.stringify({ Selected: targetIds }));
    logs.LogInfo(`[deleteDetailsWithParent] 案件ID=${parentId} 作業明細を${count}件削除しました`, 'main');
}

deleteDetails();

注記

  • 「削除後」で動かすため、案件の削除が終わってから明細を削除します。「削除前」で動かすと、明細を削除したあとに案件の削除が失敗したとき、案件が残ったまま明細が消えてしまいます。
  • 「削除後」では、context.Idに削除した案件のレコードIDが入ります。
  • 一覧画面で複数の案件を選んで一括削除したときは「削除後」が動かないため、明細は残ります。
  • 削除した明細は、作業明細テーブルのごみ箱に入ります。ごみ箱から元に戻せます。
  • 明細の絞り込みは、配列形式の値とExactMatchMultipleで完全一致にしています。ExactMatchMultipleは、分類項目がフリーテキスト・選択肢一覧・リンク設定のどの形式でも指定できる検索方法です(view.SearchTypes)。関係の無い明細を消さないよう、取得した明細の値が案件IDと一致することもコードで確かめ、レコードIDをSelectedで指定して削除しています。
  • 作業明細が期限付きテーブルの場合は、item.ResultIdをitem.IssueIdにしてください。
2. 保存期限を過ぎた記録を、毎日まとめて削除する

操作ログなどの記録テーブルで、記録日が保存期限(このサンプルでは365日)より前のレコードを、バックグラウンドサーバスクリプトで毎日まとめて削除します。記録日で絞り込んだ候補を集め、記録日が基準日より前であることをコードでも確かめてから、レコードIDを指定してitems.BulkDeleteで削除します。

実務での使いどころ

入退室の記録・操作ログ・問い合わせの受付記録など、規程で保存期間が決まっていて、期間を過ぎたものは削除することになっている記録に使えます。標準の一括削除は一覧画面で人が選んで実行するもので、決まった時刻に条件で削除する機能はありません。毎月一覧で絞り込んで削除する手間と、削除し忘れ・削除し過ぎを防げます。

事前準備

1:Script.jsonのBackgroundServerScriptをtrueにし、プリザンターを再起動してください。バックグラウンドサーバスクリプトは特権ユーザのみ設定できます。

2:「操作ログ」テーブル(記録テーブル)で、以下の項目を有効化してください。

項目コード 内容
日付A(DateA) 記録日。作成した日を入れるときは、既定値を設定します

3:サンプルコードの【操作ログのサイトID】を、操作ログのテーブルのサイトIDに書き換えます。

4:バックグラウンドサーバスクリプトを登録します。

4-1:「テナントの管理 > サーバスクリプト」タブで「新規作成」を選択する。
 4-2:実行ユーザ: 操作ログのレコードを削除できるユーザ
 4-3:タイトル: 任意の名前(例:deleteExpiredRecords)
 4-4:サーバスクリプト: 下記サンプルコードを貼り付け
 4-5:スケジュール: 「毎日」で、実行する時刻を設定
 4-6:「追加」をクリックし、画面下部の「更新」をクリックする

5:登録したスクリプトを開き、「今すぐ実行」で動かします。DRY_RUNがtrueのあいだは削除せず、候補と削除対象の件数をシステムログに出します。件数を確かめてからDRY_RUNをfalseにしてください。

JavaScript
// 削除する記録テーブルのサイトID
const SITE_ID = 【操作ログのサイトID】;
// 記録日を持つ日付の項目
const DATE_COLUMN = 'DateA';
// 保存する日数。記録日が「実行日のこの日数前」より前のレコードを削除する
const RETENTION_DAYS = 365;
// true のあいだは削除せず、件数をログに出すのみ。件数を確かめてから false にする
const DRY_RUN = true;
// 1回の items.BulkDelete で指定するレコードの数
const CHUNK_SIZE = 200;

function formatDate(date) {
    const pad = (n) => String(n).padStart(2, '0');
    return `${date.getFullYear()}/${pad(date.getMonth() + 1)}/${pad(date.getDate())}`;
}

// 記録日が基準日より前のレコードを、200件を超えても全件集める
function getCandidates(lastDay) {
    const candidates = [];
    let offset = 0;
    while (true) {
        const data = {
            View: { ColumnFilterHash: { [DATE_COLUMN]: `[",${formatDate(lastDay)} 23:59:59.997"]` } },
            Offset: offset,
        };
        const results = Array.from(items.Get(SITE_ID, JSON.stringify(data)));
        if (results.length === 0) {
            break;
        }
        results.forEach((item) => candidates.push(item));
        offset += results.length;
    }
    return candidates;
}

// 保存期限を過ぎた記録をまとめて削除する(バックグラウンドサーバスクリプトで毎日実行する)
function deleteExpiredRecords() {
    const now = new Date();
    // 基準日(実行日の RETENTION_DAYS 日前)。その前日までの記録日を対象にする
    const baseDay = new Date(now.getFullYear(), now.getMonth(), now.getDate() - RETENTION_DAYS);
    const lastDay = new Date(baseDay.getFullYear(), baseDay.getMonth(), baseDay.getDate() - 1);
    const candidates = getCandidates(lastDay);
    // 削除は取り消せないため、記録日が入っていて基準日より前であることを確かめ、IDで指定して削除する
    const targetIds = candidates
        .filter((item) => utilities.InRange(item[DATE_COLUMN]) && new Date(item[DATE_COLUMN]) < baseDay)
        .map((item) => item.ResultId);
    logs.LogInfo(
        `[deleteExpiredRecords] 基準日=${formatDate(baseDay)} 候補${candidates.length}件 削除対象${targetIds.length}件 DRY_RUN=${DRY_RUN}`,
        'main',
    );
    if (DRY_RUN || targetIds.length === 0) {
        return;
    }
    let deleted = 0;
    for (let i = 0; i < targetIds.length; i += CHUNK_SIZE) {
        deleted += items.BulkDelete(SITE_ID, JSON.stringify({ Selected: targetIds.slice(i, i + CHUNK_SIZE) }));
    }
    logs.LogInfo(`[deleteExpiredRecords] ${deleted}件を削除しました`, 'main');
}

deleteExpiredRecords();

注記

  • 基準日は、実行した日のRETENTION_DAYS日前です。記録日が基準日より前のレコードを削除し、基準日のレコードは残します。記録日が空のレコードは削除しません。
  • 削除したレコードは、テーブルのごみ箱に入ります。
  • 期限付きテーブルで使うときは、item.ResultIdをitem.IssueIdに書き換えてください。
  • バックグラウンドサーバスクリプトはデバッグできません。最初はDRY_RUNをtrueのまま「今すぐ実行」で件数を確かめてください。

注意事項

こちらはサーバスクリプトで使用するメソッドです。スクリプトでは使用できません。

関連情報