wistroni40-bnft

v1.1.7

Published

2 years ago

Benefit platform parameters publish job template

Downloads

0High
0Medium
0Low

steveylin

wistron i40 benefit

wistroni40-bnft

Install

npm i wistroni40-bnft --save

Quickstart

繼承效益範本，實作getBenefitParams方法

benefit.ts

import { BnftTemplate } from 'wistroni40-bnft';

/**
 * 效益使用範例
 */
class Benefit extends BnftTemplate {
  /**
   * 需要計算的廠別，若設為undefined則表示所有廠別都要計算
   */
  protected enabledPlant = ['plantA'];

  /**
   * @param config 效益設定檔
   */
  constructor(public config: BenefitConfigModel) {
    super(config);
  }

  /**
   * 取得效益參數
   *
   * @method public
   * @param condition 效益查詢條件
   * @return 回傳效益參數
   */
  public async getBenefitParams(
    condition: BenefitQueryModel,
  ): Promise<Bnft.Param[]> {
    const { site, plantCode } = condition;
    const idlCost = await this.findLatestLaborCost(
      site,
      plantCode,
      'idl',
    ).toPromise();

    const analysisParams: Bnft.Param = {
      name: 'time_analysis',
      value: 2,
      type: 'CONST',
    };

    const idlCostParams: Bnft.Param = {
      name: 'idl_pay_hr',
      value: idlCost ? idlCost.cost : 0,
      type: 'VAR',
    };

    return [analysisParams, idlCostParams];
  }
}

實例效益，使用setSchedule設定計算排成；或使用execute直接拋送效益

index.ts

import { Benefit, BenefitConfigModel } from 'wistroni40-bnft';

// 效益設定
const configuration: BenefitConfigModel = {
  systemId: 'system_id',
  typeId: 'type_id',
  benefitType: 'direct',
  publishApi: 'http://publish-api-url/',
  benefitApi: 'http://benefit-api-url/',
  retry: 3,
};

const benefit = new Benefit(configuration);

// 設定排程定時拋送
benefit.setSchedule('0 0 0 * * ? *');

// 直接拋送
benefit.execute();

// 監聽拋送結果
benefit.sendCompleted.subscribe(res => {
  if (res.error) {
    // TODO
  } else {
    // TODO
  }
});

Full Example

Feature

提供效益計算實作範本
效益上拋具備重拋及保存機制
範本中埋入 API，可執行重新計算

API

BnftTemplate

Abstract Class，效益範本

constructor

BnftTemplate 的建構值

Example:

const config = {
  systemId: 'mytest',
  typeId: 'cost_idl',
  benefitType: 'direct',
  publishApi: 'http://publish-api-url/',
  benefitApi: 'http://benefit-api-url/',
  retry: 3,
};

Properties

config

Methods

setSchedule

設定效益計算排程

getBenefitParams

取得效益參數

processBenefitParams

處理效益參數

execute

執行效益參數撈取

send

將效益參數上拋

findLatestLaborCost

取得最新的 IDL 或 ID 人員工時

setHttp

設定自定義的 HTTP

BenefitConfigModel

Interface，效益範本設定檔資料模型

Properties

dev

systemId

typeId

benefitType

publishApi

benefitApi

retry

Resend API Usage

執行效益計算 Job，執行成功，可看見以下 LOG，並在瀏覽器輸入http://localhost:3000/，可開啟 Swagger API Explorer

[2021-02-17T10:30:24.562] [INFO] api - Listen api port 3000

重新上拋特定時間的所有效益

curl -X POST "http://localhost:3000/benefit/send?timestamp=1609430400000" -H  "accept: application/json"

重新上拋特定效益

curl -X POST "http://localhost:3000/specific/benefit/send?systemId=mytest&typeId=cost_idl2&timestamp=1609430400000" -H  "accept: application/json"

重新上拋特定時間區間內的所有效益

curl -X POST "http://localhost:3000/benefit/send/timestamps" -H  "accept: application/json" -H  "Content-Type: application/json" -d "[1609430400000,1609516800000]"

重新上拋特定時間區間內的特定效益

curl -X POST "http://localhost:3000/specific/benefit/send/timestamps?systemId=mytest&typeId=cost_idl2" -H  "accept: application/json" -H  "Content-Type: application/json" -d "[1609430400000]"

重拋上拋失敗的效益

curl -X POST "http://localhost:3000/benefit/backup" -H  "accept: application/json"

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

wistroni40-bnft

Install

Table of Contents

Quickstart

Feature

API

BnftTemplate

constructor

Properties

config

Methods

setSchedule

getBenefitParams

processBenefitParams

execute

send

findLatestLaborCost

setHttp

BenefitConfigModel

Properties

dev

systemId

typeId

benefitType

publishApi

benefitApi

retry

Resend API Usage

重新上拋特定時間的所有效益

重新上拋特定效益

重新上拋特定時間區間內的所有效益

重新上拋特定時間區間內的特定效益

重拋上拋失敗的效益