実績工数を定期的に削除する

概要

TimeTracker NXの各種データは、年々蓄積されていきます。運用状況によっては、管理が不要になったデータを削除することもあるかもしれません。 そこで、参照する必要がなくなった古い実績工数を削除して、管理対象のデータを絞り込む際にWeb APIを利用すれば、漏れなく対象のデータを削除できます。

利用場面

• 集計や参照に利用しなくなった古い実績工数を削除する

使用するAPI

以下のAPIを使用します。

• ユーザーの取得
• 実績工数の取得
• 実績工数の削除

サンプルスクリプト

//======================================================================
//  実績工数を削除する
//======================================================================
//======================================================================
//  外部ファイル（ライブラリ、他ファイル）のインクルード
//======================================================================

const https = require('https'); // HTTPS通信を利用する場合に設定する
const http = require('http');　// HTTP通信を利用する場合に設定する
const axios = require('axios');
const fs = require('fs');

//======================================================================
//  共通部の定義
//======================================================================

// APIを呼び出すURLを設定する
const baseURLString = 'http://yourserver/TimeTrackerNX/api';

// サーバースペックに合わせてウェイト時間を設定する
// 1分間に1500件程度の処理に収まるようするため、
// 目安として推奨スペックでは100ms程度とする　
const requestWaitTime = 100;    //単位：ms

//----------------------------------------------------------------------
//  Web API間の処理待ち関数
//----------------------------------------------------------------------
async function wait(time){
    const d1 = new Date();
    while (true) {
        const d2 = new Date();
        if (d2 - d1 > time) {
            break;
        }
    }
}

//======================================================================
//  メイン処理
//======================================================================
main();

async function main(){

    // 引数チェック    
    if (process.argv.length < 3){
        return 'enter username and password'; 
    }

    const userName = process.argv[2];
    var pass;
    var authString; //ブロック内スコープから外に出すためvarで宣言（固定値）

    // 引数でパスワードが未入力の場合は空白とみなす
    if (process.argv.length > 3){
        pass = process.argv[3];
    } else {
        pass = '';        
    }

    // 認証情報を取得する
    var sendUrl = baseURLString + '/auth/token';

    try{
        const { data } = await axios.post(
            sendUrl,
            {
                loginName : userName,
                password : pass
            },
/*
        // https通信時に使用する
        httpsAgent  : new https.Agent({
            rejectUnauthorized: false
                    })
*/    
        );
        authString = 'Bearer ' + data.token;

    } catch (err) {
        console.log(err);
    }

    // 以降のAPI通信で利用する送信ヘッダを作成する
    const request = axios.create({
        baseURL     : baseURLString,
        headers     :{
                        'Authorization'   : authString
                    },
/*
        // https通信時に使用する
        httpsAgent  : new https.Agent({
            rejectUnauthorized: false
                    })
*/    
    });

    // JSON形式のデータ（例：後述のdeleteActualTime.json）を入力とする
    const filepath = './deleteActualTime.json';

    var updateData = JSON.parse(fs.readFileSync(filepath, {encoding: "utf-8"}));

    // JSON形式の実績工数データから１つ分のデータを取り出す
    for (key in updateData){
        var sendUrl = '/system/users';
        var userId;

        // 実績を削除する対象ユーザのID取得
        // ユーザーを一意に特定できる情報（コード）をもとに、実績を削除する対象ユーザーのIDを取得
        try {
            const { data } = await request.get(
                sendUrl,
                {
                    params: {
                        code                : updateData[key].code
                    }
                }
            );
            userId = data.data[0].id;
        } catch (e) {
            console.log(e);
        }

        // 削除対象の実績工数のIDを取得する
        sendUrl = '/system/users/' + userId + '/timeEntries';

        // 実績の取得 （リクエストに検索用の実績工数情報を設定して送信）
        try {
            const { data } = await request.get(
                sendUrl,
                {
                    params: {
                        startDate   : updateData[key].startDate,
                        finishDate  : updateData[key].finishDate,
                        workItemId  : updateData[key].workItemId
                    }
                }                
            ); 

            // 検索で見つかった実績データを一つずつ削除する
            for ( timeEntriesData in data.data ){
                //　実績の削除
                sendUrl = '/system/users/'+userId+'/timeEntries/'+ data.data[timeEntriesData].id;
                try {
                    const { data } = await request.delete(
                        sendUrl
                    ); 
                } catch (e) {
                    console.log(e);
                }; 
                await wait(requestWaitTime); 
            }
        } catch (e) {
            console.log(e);
        }
        await wait(requestWaitTime);      
    }
}

入力情報

以下のサンプルスクリプトで使用する削除用の実績情報ファイルを以下のリンク先から参照できます。

• 実績工数削除用 - deleteActualTime.json