複数プロジェクトの一覧情報をタイムリーに確認する

概要

TimeTracker NXはプロジェクトの横断管理にも対応していますが、Web APIを活用することで、複数プロジェクトの情報をさらに柔軟に必要な情報を取得することができます。全社単位あるいは部門単位など、必要なレベルで必要なデータをタイムリーに管理できます。
利用場面

各プロジェクトの工数やコストの状況を全社単位で確認する
部門内で稼働中の各プロジェクトについて、進捗状況を比較する
使用するAPI

以下のAPIを使用します。
プロジェクトの取得
ワークアイテムの取得
サンプルスクリプト

//======================================================================
//  プロジェクト情報を出力する
//======================================================================
//======================================================================
//  外部ファイル（ライブラリ、他ファイル）のインクルード
//======================================================================

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

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

// 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
                    })
*/    
                });

    // プロジェクト情報を取得する
    var sendUrl = '/project/projects';
    let rootWorkItemIds = "";

    // 稼働中のプロジェクト情報を取得する（リクエストに稼働状態の条件を設定して送信）
    try {
        const { data } = await request.get(
            sendUrl,
            {
                params: {
                    isFinished          :"false"
                }
            }
        );

        // 初回のデータ書き込み時に見出しを追加するためのフラグを設定
        var headerFlag = 1;

        // 取得したプロジェクトからデータを取得する
        for (var key in data.data){
            sendUrl = '/workItem/workItems/' + data.data[key].workItemRootFolderId + '/subItems';

            // ルートワークアイテムのフィールド情報の取得 （リクエストに出力するフィールドを設定して送信）
            try {
                const { data } = await request.get(
                    sendUrl,
                    {
                        params: {
                            fields              : 'ProjectId,ProjectName,ProjectCode,StatusTypeId,Description,ItemNumber,ActualProgress,PlannedStartDate,PlannedFinishDate,PlannedTime,ActualTime,ActualStartDate,ActualFinishDate,RemainingTime,PlannedCost,ActualCost,OutputScalePlan,OutputScaleActual,OutputUnit,OutputInfo,LeaderId,FinishDate,WorkingDayCount,PassedWorkingDayCount,SPI,TPI,CPI',
                            depth               : 0
                        }
                    }
                );

                // 取得したデータをCSV形式で出力する
                outputData(headerFlag, data);

                // 初回のデータ書き込みが終わったタイミングでフラグを無効にする
                if(headerFlag == 1){
                    headerFlag = 0;
                }

            } catch (e) {
                console.log(e);
            } 
            await wait(requestWaitTime);
        }
    } catch (e) {
        console.log(e);
    }
}

function outputData(headerFlag, data){
    var filepath = './output.csv';
    var buffer;

    // 初回の書き込みのみヘッダを追加
    if(headerFlag == 1){

        buffer = 'Id,ProjectId,ProjectName,ProjectCode,StatusTypeId,Description,ItemNumber,ActualProgress,PlannedStartDate,PlannedFinishDate,PlannedTime,ActualTime,ActualStartDate,ActualFinishDate,RemainingTime,PlannedCost,ActualCost,OutputScalePlan,OutputScaleActual,OutputUnit,OutputInfo,LeaderId,FinishDate,WorkingDayCount,SPI,TPI,CPI,IsAclInherited,CanEdit\n';

        fs.writeFileSync(filepath, iconv.encode(buffer, 'Shift_JIS'), function(err){
            if (err) {
                console.log(err);
            }
        });
    }

    // 1行分ごとにデータをファイルへ追記する
    for (var key in data){

        var array = [
            data[key].fields.Id,
            data[key].fields.ProjectId,
            data[key].fields.ProjectName,
            data[key].fields.ProjectCode,
            data[key].fields.StatusTypeId,
            data[key].fields.Description,
            data[key].fields.ItemNumber,
            data[key].fields.ActualProgress,
            data[key].fields.PlannedStartDate,
            data[key].fields.PlannedFinishDate,
            data[key].fields.PlannedTime,
            data[key].fields.ActualTime,
            data[key].fields.ActualStartDate,
            data[key].fields.ActualFinishDate,
            data[key].fields.RemainingTime,
            data[key].fields.PlannedCost,
            data[key].fields.ActualCost,
            data[key].fields.OutputScalePlan,
            data[key].fields.OutputScaleActual,
            data[key].fields.OutputUnit,
            data[key].fields.OutputInfo,
            data[key].fields.LeaderId,
            data[key].fields.FinishDate,
            data[key].fields.WorkingDayCount,
            data[key].fields.SPI,
            data[key].fields.TPI,
            data[key].fields.CPI,
            data[key].fields.IsAclInherited,
            data[key].fields.CanEdit
        ]
        buffer = array.join(',') + '\n';

        fs.appendFileSync(filepath, iconv.encode(buffer, 'Shift_JIS'), function(err){
            if (err) {
                console.log(err);
            }
        });
    }
}