NX Context-based Data Management
System for Embedded device ユーザーズ
ガイド
IOT-7-0006

■ 対象製品
S-741E-00P 組込み装置向けデータ管理基盤 01-00 以降（適用 OS：Windows 10）■ 輸出時の注意
本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。
なお、不明な場合は、弊社担当営業にお問い合わせください。

■ 商標類
HITACHI は、株式会社 日立製作所の商標または登録商標です。
Microsoft、Visual Studio、Windows は、米国 Microsoft Corporation の米国およびその他の国における登録商標または商標です。
その他記載の会社名、製品名などは、それぞれの会社の商標もしくは登録商標です。

■ マイクロソフト製品の表記について
このマニュアルでは，マイクロソフト製品の名称を次のように表記しています。
表記

製品名

Visual Studio

Microsoft(R) Visual Studio(R) 2015

Windows 10

Microsoft(R) Windows(R) 10 IoT Enterprise 2016 LTSB (64bit)■ 注意
このマニュアルの一部または全部を無断で転写したり複写したりすることは、固くお断りいたします。
このマニュアルの内容を、改良のため予告なしに変更することがあります。
システムの構築やプログラムの作成などは、このマニュアルの記載内容をよく読み、書かれている指示や注意を十分理解してから行ってください。誤操作によって、システムの故障が発生することがあります。
このマニュアルは、必要なときすぐに参照できるよう、手近なところに保管してください。
このマニュアルの記載内容について疑問点または不明点がございましたら、最寄りの弊社営業または SE までお知らせください。
お客様の誤操作に起因する事故発生や損害につきましては、弊社では責任を負いかねますのでご了承ください。
弊社提供ソフトウェアを改変して使用した場合に発生した事故や損害につきましては、弊社では責任を負いかねますのでご了承ください。
弊社提供以外のソフトウェアを使用した場合の信頼性については、弊社では責任を負いかねますのでご了承ください。
ファイルのバックアップ作業を日常業務に組み入れてください。ファイル装置の障害、ファイルアクセス中の停電、誤操作、その他何らかの原因によってファイルの内容を消失することがあります。このような事態に備え、計画的にファイルのバックアッ
プを取っておいてください。

■ 発行
2019 年 11 月（第 1 版）IOT-7-0006■ 著作権
All Rights Reserved. Copyright (C) 2019, Hitachi, Ltd.

はじめに
このマニュアルは、組込み装置向けデータ管理基盤（NX Context-based Data Management System for
Embedded device、以降 NX CDMS Embedded と略す）の機能や操作方法について説明したものです。

■ 対象読者
次に示す方を対象としています。
• NX CDMS Embedded を構築・運用する方• NX CDMS Embedded を利用して、現場データとは独立して、現場データの拡張およびアプリケーションの拡張などを実施する方■ マニュアルの構成
このマニュアルは，次に示す章と付録から構成されています。
第１章

概説
NX CDMS Embedded の概要について説明しています。

第２章

NX CDMS Embedded の機能
NX CDMS Embedded の機能について説明しています。

第３章

コマンド一覧
NX CDMS Embedded で提供する各種コマンドについて説明しています。

第４章

保存領域操作 API
保存領域に蓄積したデータの参照や削除を行う API について説明しています。

第５章

定義ファイル
NX CDMS Embedded で使用する定義ファイルについて説明しています。

第６章

Windows イベントログ
Windows イベントログについて説明しています。

第７章

保存領域操作 API を使ったアプリケーション作成
保存領域操作 API を使ったアプリケーションの作成について説明しています。

第８章

HX-DSM との連携
HX-DSM との連携について説明しています。

付録 A

用語解説
このマニュアル内で使用する用語について説明しています。

■ このマニュアルで使用する書式
このマニュアルで使用する書式を説明します。
書式

文字列

説明
可変の値を示します。
（例）日付は yyyyMMdd の形式で指定します。

NX_CDMS_EMB_DIR

NX CDMS Embedded のインストールパスを示します。

I

はじめに

書式

説明
環境変数 NX_CDMS_EMB_DIR に設定されます。

［］

ウインドウ、ダイアログボックス、メニュー、ボタンなどの画面上の要素名を示します。

＜＞

キーボードのキーを示します。

■ このマニュアルで使用する KiB（キビバイト）などの単位表記
1KiB（キビバイト）、1MiB（メビバイト）、1GiB（ギビバイト）、1TiB（テビバイト）はそれぞれ 1,024 バイト、
1,0242 バイト、1,0243 バイト、1,0244 バイトです。

II

目次

1

概説
1.1

1
概要

2

1.1.1 背景

2

1.1.2

2

NX CDMS Embedded とは

1.1.3 NX CDMS Embedded の時刻の取り扱い

1.2

1.3

2

3

システム要件5
6

1.2.1 ハードウェア要件

6

1.2.2

6

ソフトウェア要件

構築から運用まで

7

1.3.1

概略フロー

7

1.3.2

初期構築フロー8

1.3.3

障害対策フロー10

1.3.4 定義変更フロー11

1.3.5 プログラムプロダクト更新フロー

12

NX CDMS Embedded の機能

15

2.1

サポート機能一覧

16

2.2

起動停止機能18

2.3

データ収集蓄積機能

19

2.4

データ項目紐付け機能

23

2.5

保存領域操作機能

24

2.6

データ名称定義機能25

2.7

RAS 機能26

2.8

情報／状態表示機能

27

2.9

インストーラ／アンインストーラ機能

28

2.9.1

インストーラ28

2.9.2

アンインストーラ

29

コマンド一覧

31

3.1

提供コマンド一覧

32

3.2

起動コマンド33

3.2.1

コマンド形式

33

3.2.2

コマンドの説明33

3.2.3 前提条件

33

3.2.4

戻り値

33

3.2.5 メッセージ一覧

33

i

目次

3.3

3.4

3.5

3.6

4

35

3.3.1

コマンド形式

35

3.3.2

コマンドの説明

35

3.3.3

前提条件

35

3.3.4

戻り値

35

3.3.5

メッセージ一覧

35

RAS コマンド

37

3.4.1

コマンド形式

37

3.4.2

コマンドの説明

37

3.4.3

前提条件

38

3.4.4

戻り値

38

3.4.5

メッセージ一覧

39

プログラムプロダクト情報表示コマンド

40

3.5.1

コマンド形式

40

3.5.2

コマンドの説明

40

3.5.3

前提条件

40

3.5.4

戻り値

40

3.5.5

メッセージ一覧

40

動作状態表示コマンド

42

3.6.1

コマンド形式

42

3.6.2

コマンドの説明

42

3.6.3

前提条件

42

3.6.4

戻り値

42

3.6.5

メッセージ一覧

42

保存領域操作 API

45

4.1

保存領域操作 API 一覧

46

4.2

初期化 API

47

4.3

4.4

4.5

ii

停止コマンド

4.2.1

API の説明47

4.2.2

インターフェイス

47

4.2.3

戻り値

47

終了処理 API

48

4.3.1

API の説明48

4.3.2

インターフェイス

48

4.3.3

戻り値

48

定常監視データ読込 API

49

4.4.1

API の説明49

4.4.2

インターフェイス

49

4.4.3

戻り値

50

ロググループ読込 API

51

目次

API の説明51

4.5.2 インターフェイス

51

4.5.3

52

4.5.1

4.6

4.7

ロググループ削除 API

5

53

4.6.1

API の説明53

4.6.2

インターフェイス

53

4.6.3

戻り値

53

ロググループ容量取得 API

54

API の説明54

4.7.2 インターフェイス

54

4.7.3

55

4.7.1

4.8

戻り値

戻り値

リターンコード一覧

56

定義ファイル57

5.1

定義ファイル一覧

58

5.2

定義ファイルにおける注意事項

60

5.3

定義ファイルの共通仕様

61

5.4

定義ファイルの配置場所

62

5.5

データ用リングバッファ定義ファイル

63

5.6

5.7

5.8

5.9

5.5.1

ファイルの説明

63

5.5.2

ファイル名称63

5.5.3

定義記述方法63

データ項目紐付け定義ファイル

65

5.6.1

ファイルの説明65

5.6.2

ファイル名称65

5.6.3

定義記述方法65

データ名称定義ファイル

67

5.7.1

ファイルの説明67

5.7.2

ファイル名称67

5.7.3

定義記述方法

67

トリガー用リングバッファ定義ファイル

69

5.8.1

ファイルの説明69

5.8.2

ファイル名称69

5.8.3

定義記述方法69

イベントトリガー定義ファイル

72

5.9.1

ファイルの説明72

5.9.2

ファイル名称72

5.9.3

定義記述方法

72

iii

目次

6
7
8

Windows イベントログ

75

6.1

76

Windows イベントログ一覧

保存領域操作 API を使ったアプリケーション作成

79

7.1

インクルードファイル

80

7.2

DLL（Dynamic Link Library）

81

7.3

作成環境

82

7.4

保存領域操作 API 使用時の注意事項

83

HX-DSM との連携

85

8.1

86

データ用リングバッファの注意事項
データ用リングバッファへの書き込み

86

トリガー用リングバッファの注意事項

87

8.1.1

8.2

付録

8.2.1

トリガー用リングバッファへの書き込み

87

8.2.2

トリガー用リングバッファからの読み込み

87

付録 A

索引

iv

89
用語解説

90

91

1

概説
この章では、NX CDMS Embedded の概要について説明します。

1

1 概説

1.1

概要

ここでは、NX CDMS Embedded の概要について説明します。

1.1.1

背景

近年、競争が激化する工作機械業界で、その競争軸が従来の多機能化・機械性能向上から、故障診断やパラメータチューニングといった工作機械由来のデータを活用した新たなサービスにシフトしています。これら新サービスを実現するためには、リアルタイムでのデータの高速処理が不可欠です。しかし、クラウドを利用した場合は処理スピードの遅さが課題となり、エッジコンピューティングの場合ではデータ量の多さが
課題です。

1.1.2

NX CDMS Embedded とは組込み装置上で時系列データを収集し、蓄積することで、「組込み装置のスマート化・IoT 化を実現し、デー
タ利活用の効率性の向上」を可能にするプラットフォームです。
NX CDMS Embedded が解決する課題を次の図に示します。
図 1‒1

NX CDMS Embedded が解決する課題

NX CDMS Embedded では、現場データと独立で、現場データの拡張、アプリケーションの拡張を容易にします。
NX CDMS Embedded のメリットを次の図に示します。

2

1

図 1‒2

概説

NX CDMS Embedded のメリット• 現場データ管理者は、現場の時系列データのフォーマットを定義するだけで、現場のデータを提供できます。
• データ利用者は、必要なデータ項目と標準名称を定義することで、必要なデータを入手でき、データをより使いやすくするとともに、データを活用したアプリケーションの横展開を容易にします。
NX CDMS Embedded が実現するシステム全体構成の例を次の図に示します。

3

1

概説

図 1‒3 NX CDMS Embedded が実現するシステム全体構成の例(1)

共有メモリー上に書き込まれた時系列データを、定周期、またはトリガー通知によって収集します。
トリガーにはあらかじめ、蓄積対象のデータ、サンプリング周期、取得期間を定義できます。
トリガーの通知は共有メモリーを介して行われ、トリガーが通知された場合、NX CDMS Embedded はトリガーの定義に基づいて時系列データを保存領域に蓄積します。なお、トリガーの種類には、共有メモリー上の時系列データをすべて保存領域に蓄積するエラートリガーとユーザーが任意に選択した時系列データ
を保存領域に蓄積するイベントトリガーの 2 種類があります。

4

1

(2)

概説

保存領域には、定周期による収集、エラートリガーによる収集、イベントトリガーによる収集の 3 種類の領域があります。
それぞれの領域に保存できるサイズの上限は 300MiB です。
上限に達した場合、定周期による収集では、最古に登録したデータから順に上書きします。
エラートリガーとイベントトリガーによる収集では、データの削除が実施されるまで保存は行なわれません。
NX CDMS Embedded が提供するインターフェイスによって、適宜、削除を実施してください。

(3)

保存領域に蓄積されたデータは、NX CDMS Embedded が提供するインターフェイス
によって取得できます。
保存領域上では各データは Data1、Data2…のように番号で管理するため、各番号に対し別名を定義する
ことで、アプリケーションはその名称でデータを取得できます。

1.1.3

NX CDMS Embedded の時刻の取り扱い

NX CDMS Embedded での時刻の取り扱い方針を次の表に示します。
表 1‒1
項番

時刻の取り扱い項目

詳細

1Windows のイベントログ出力

ローカルタイム（Windows の仕様に準拠します）。

2

NX CDMS Embedded が収集し、保存領域に格納するデータ内の時刻

UTC（1970/01/01 00:00:00.000 からのミリ秒で表記
します）。

3

NX CDMS Embedded が提供するインターフェイスによって出力するデータ内の時刻

UTC（1970/01/01 00:00:00.000 からのミリ秒で表記
します）。

5

1

概説

1.2

システム要件

ここでは、NX CDMS Embedded のシステム要件について説明します。

1.2.1

ハードウェア要件

NX CDMS Embedded が前提とするハードウェアを次の表に示します。
表 1‒2

前提ハードウェア

項番

分類

ハードウェア要件

1

アーキテクチャ

x64

2

CPU

クロック周波数：1.91GHz 以上、コア数：2 コア以上※

3RAM

1.5GiB 以上※

4

SSD

1GiB 以上※

注※
OS などの前提ソフトウェア、および共存させる他のソフトウェアのリソースは別に確保する必要があ
ります。

1.2.2

ソフトウェア要件

NX CDMS Embedded が前提とするソフトウェアを次の表に示します。
表 1‒3
項番
1

前提ソフトウェア
プログラム
プロダクト
NX CDMS Embedded

前提ソフトウェア• Microsoft(R) Windows(R) 10 IoT Enterprise 2016 LTSB (64bit)• HX-DSM（型式：S-763A-96P）

6

1

1.3

概説

構築から運用まで

ここでは、NX CDMS Embedded の初期構築から運用まで、および保守に関する作業の概略について説明
します。

1.3.1

概略フロー

初期構築から運用までの概略フローを次の図に示します。
図 1‒4

(1)

構築から運用までの概略フロー

前提環境のインストール
最初に前提環境をインストールします。
「1.2 システム要件」を参照し、前提となるハードウェア、ソフト
ウェアを準備し、各ハードウェア、ソフトウェアのマニュアルを参照してインストールしてください。

(2) 初期構築
NX CDMS Embedded の初期構築を行います。
詳細については、「1.3.2(3)

初期構築フロー」を参照してください。

オンライン運用
NX CDMS Embedded は、動作定義に従ってデータの収集・蓄積を行います。
定常時はこの状態でシステムの運用を続けてください。
障害が発生した場合、システム増改築に合わせ NX CDMS Embedded の動作定義を変更する場合、プロ
グラムプロダクトのバージョンアップのためにプログラムプロダクトを更新する場合は、それぞれの手順を実施してください。

(4)

障害対策
NX CDMS Embedded で障害が発生した場合は、障害の調査・対策を実施します。

7

1

概説

詳細については、「1.3.3(5)

障害対策フロー」を参照してください。

定義変更
NX CDMS Embedded の動作定義を変更する場合、動作定義を更新し再起動することで定義変更ができます。
詳細については、「1.3.4(6)

定義変更フロー」を参照してください。

プログラムプロダクト更新
プログラムプロダクトのバージョンアップをする場合は、「1.3.5順を実施してください。

1.3.2

プログラムプロダクト更新フロー」の手

初期構築フロー

NX CDMS Embedded のプログラムプロダクトをインストール後、最初に実施する初期構築作業の概略フローを次の図に示します。
図 1‒5

(1)

初期構築の概略フロー

NX CDMS Embedded のインストール
NX CDMS Embedded をインストールする手順を次に示します。
1. NX CDMS Embedded のインストール CD の［setup.exe］を右クリックし、［管理者として実行］をクリックします。
［インストール開始］画面が表示されます。［ユーザーアカウント制御］ダイアログが表示された場合は、［はい］ボタンをクリックしてください。
2. 表示された［インストール開始］画面で、［次へ］ボタンをクリックします。

8

1

概説

［インストール先の選択］ダイアログが表示されます。
3. 表示された［インストール先の選択］ダイアログで、［参照］ボタンをクリックしてインストール先を選択後、［次へ］ボタンをクリックします。
インストールが開始され、インストールが完了すると［インストール完了］画面が表示されます。
4. 表示された［インストール完了］画面で、［完了］ボタンをクリックします。
「NX-CDMS-EMB マニュアルの構築手順に従って、ローカルグループポリシーのシャットダウンスク
リプトへ NX-CDMS-EMB 停止処理の登録を行ってください。」という［メッセージ］ダイアログが表示されます。
5. 表示された［メッセージ］ダイアログで、［OK］ボタンをクリックします。
［メッセージ］ダイアログが閉じます。
6. 管理者権限が付与されたコマンドプロンプトから、次のプログラムプロダクト情報表示コマンドを実行
し、インストールの成功を確認します。
cdms_emb_info.bat

プログラムプロダクト情報表示コマンドの詳細については、「3.5
ンド」を参照してください。

プログラムプロダクト情報表示コマ

7. Windows の［スタート］ボタンを右クリックし、［ファイル名を指定して実行］をクリックします。
［ファイル名を指定して実行］ダイアログが表示されます。
8. 表示された［ファイル名を指定して実行］ダイアログで、実行するプログラム名称に「gpedit.msc」と入力して、［OK］ボタンをクリックします。
［ローカル グループ ポリシー エディター］画面が表示されます。
9. 表示された［ローカル グループ ポリシー エディター］画面で、コンソールツリーの［コンピューターの構成］−［Windows の設定］−［スクリプト（スタートアップ/シャットダウン）］をクリックし、右側の結果ウインドウに表示される［シャットダウン］をダブルクリックします。
［シャットダウンのプロパティ］ダイアログが表示されます。
10. 表示された［シャットダウンのプロパティ］ダイアログで、［追加］ボタンをクリックします。
［スクリプトの追加］ダイアログが表示されます。
11. 表示された［スクリプトの追加］ダイアログの［参照］ボタンをクリックして、NX CDMS Embeddedのインストールディレクトリの bin フォルダ配下にある cdms_emb_stop.bat ファイルを選択し、［OK］ボタンをクリックします。
［スクリプトの追加］ダイアログが閉じます。
12. 表示された［シャットダウンのプロパティ］ダイアログで、［適用］ボタンをクリック後、［OK］ボタ
ンをクリックします。
［シャットダウンのプロパティ］ダイアログが閉じます。

(2) NX CDMS Embedded 動作定義ファイルの作成
NX CDMS Embedded の動作定義ファイルを作成します。
作成する定義ファイルについては、「5(3)定義ファイル」を参照してください。

計算機再起動定義に誤りがないことを確認した上で、計算機を再起動します。再起動後、NX CDMS Embedded が動作を開始します。

9

1

概説

定義に誤りがある場合は、動作を停止します。出力されたエラーを確認して、定義ファイルの誤りを訂正してください。
NX CDMS Embedded の動作が開始できているかは、次の動作状態表示コマンドを実行し確認してください。
cdms_emb_stat.exe

動作状態表示コマンドの詳細については、「3.6

1.3.3

動作状態表示コマンド」を参照してください。

障害対策フロー障害が発生した場合に行なう調査・対策・復旧作業の概略フローを次の図に示します。
図 1‒6

(1)

障害対策の概略フロー

イベントログの確認
NX CDMS Embedded の障害情報は、Windows イベントログに記録されます。
Windows イベントログを参照し、NX CDMS Embedded の障害情報を確認してください。

10

1

(2)

概説

トラブルシューティング
Windows イベントログに NX CDMS Embedded のイベントが記録されている場合は、「6 Windows
イベントログ」を参照してください。そのイベントの意味とともに対処方法を記載していますので、その対処方法に従って対策してください。対策の結果、障害が取り除かれれば、障害対策は終了です。

(3)

他の原因の調査・対策
Windows イベントログにイベントが記録されていない場合、他の要因のおそれがあるため、他の原因を調査し、原因を取り除いてください。

(4) 稼働状態の保存、問い合わせ窓口に連絡、対策
次に示す場合、「2.7い。
• 「6RAS 機能」の手順に従い、NX CDMS Embedded の RAS ログを回収してくださ

Windows イベントログ」に記載の対策を実施しても障害が回復しない場合• Windows イベントログに NX CDMS Embedded のイベントがなく、他の原因も見つからない場合
その後、問い合わせ窓口に連絡して指示に従い、対策してください。
対策の結果、障害の原因が取り除かれれば、障害対策は終了です。
なお、システムを復旧するには計算機の再起動が必要です。ただし、障害の原因が取り除かれていない場合
は、再度同じ障害が起きるおそれがあります。

1.3.4

定義変更フローシステムの増改築やトラブルシューティングのために、運用中の NX CDMS Embedded の動作定義を変更する作業の概略フローを次の図に示します。
図 1‒7

定義変更の概略フロー

11

1 概説

(1)

NX CDMS Embedded の停止
次の停止コマンドを実行し、NX CDMS Embedded を停止してください。
cdms_emb_stop.bat

停止コマンドの詳細については、「3.3(2)

停止コマンド」を参照してください。

NX CDMS Embedded 動作定義ファイルの修正
NX CDMS Embedded の定義ファイルを変更してください。
詳細については、「5定義ファイル」を参照してください。

(3) NX CDMS Embedded の再起動
定義に誤りがないことを確認した上で、NX CDMS Embedded を再起動します。再起動後、NX CDMS
Embedded が動作を開始します。
次の起動コマンドを実行し、NX CDMS Embedded を再起動してください。
cdms_emb_start.bat

開始コマンドの詳細については、「3.2起動コマンド」を参照してください。

定義に誤りがある場合は、動作を停止します。出力されたエラーを確認して、定義ファイルの誤りを訂正してください。
NX CDMS Embedded の動作が開始できているかは、次の動作状態表示コマンドを実行し確認してください。
cdms_emb_stat.exe

動作状態表示コマンドの詳細については、「3.6動作状態表示コマンド」を参照してください。

注
計算機を再起動することで、NX CDMS Embedded を再起動できます。

1.3.5

プログラムプロダクト更新フロー

運用中の NX CDMS Embedded に対し、バージョンアップなどのためにアンインストール、または再イ
ンストールする作業の概略フローを次の図に示します。

12

1

図 1‒8

(1)

概説

プログラムプロダクト更新の概略フロー

NX CDMS Embedded の停止
次の停止コマンドを実行し、NX CDMS Embedded を停止してください。
cdms_emb_stop.bat

停止コマンドの詳細については、「3.3(2)

停止コマンド」を参照してください。

NX CDMS Embedded のアンインストール
NX CDMS Embedded をアンインストールする手順を次に示します。
1. Windows の［コントロール パネル］から「プログラムと機能」を選択します。
2. 表示された［プログラムと機能］画面から「NX-CDMS-EMB」を選択します。

13

1

概説

3. 右クリックして表示されるメニューから「アンインストール」を選択します。
アンインストールをするかどうかの確認ダイアログが表示された場合は、［はい］ボタンをクリックしてください。
NX CDMS Embedded がアンインストールされます。

(3)

NX CDMS Embedded のインストール
NX CDMS Embedded をインストールする手順を次に示します。
1. NX CDMS Embedded のインストール CD の［setup.exe］をダブルクリックします。
［インストール開始］画面が表示されます。
2. 表示された［インストール開始］画面で、［次へ］ボタンをクリックします。
［インストール先の選択］ダイアログが表示されます。
3. 表示された［インストール先の選択］ダイアログで、［参照］ボタンをクリックしてインストール先を選択後、［次へ］ボタンをクリックします。
インストールが開始され、インストールが完了すると［インストール完了］画面が表示されます。
4. 表示された［インストール完了］画面で、［完了］ボタンをクリックします。
5. 次のプログラムプロダクト情報表示コマンドを実行し、インストールの成功を確認します。
cdms_emb_info.bat

プログラムプロダクト情報表示コマンドの詳細については、「3.5
ンド」を参照してください。

プログラムプロダクト情報表示コマ(4) NX CDMS Embedded の動作定義ファイルの修正
機能追加などによって定義項目が追加される場合があります。
追加した定義項目はデフォルト値で動作しますが、デフォルト値からの変更が必要な場合は、NX CDMS
Embedded の動作定義ファイルを修正します。
修正する定義ファイルについては、「5(5)定義ファイル」を参照してください。

計算機再起動定義に誤りがないことを確認した上で、計算機を再起動します。再起動後、NX CDMS Embedded が動作を開始します。
定義に誤りがある場合は、動作を停止します。出力されたエラーを確認して、定義ファイルの誤りを訂正してください。
NX CDMS Embedded の動作が開始できているかは、次の動作状態表示コマンドを実行し確認してください。
cdms_emb_stat.exe

動作状態表示コマンドの詳細については、「3.614動作状態表示コマンド」を参照してください。

2

NX CDMS Embedded の機能
この章では、NX CDMS Embedded の機能について説明します。

15

2

NX CDMS Embedded の機能

2.1

サポート機能一覧

ここでは、NX CDMS Embedded のサポート機能について説明します。
NX CDMS Embedded が実現するシステム全体構成の例を次の図に示します。
図 2‒1

NX CDMS Embedded が実現するシステム全体構成の例

NX CDMS Embedded がサポートする機能の一覧を次の表に示します。

16

2

表 2‒1
項番

NX CDMS Embedded の機能

NX CDMS Embedded サポート機能一覧
機能

説明

参照項

1

起動停止機能NX CDMS Embedded サービスの起動、および停止を行なうコマンドインターフェイスをサポートし
ます。

「2.2

起動停止機能」

2

データ収集蓄積機能

共有メモリー上に書き込まれた時系列データを、定周期、または共有メモリーに設定されたトリガーの通知によって、保存領域に蓄積します。

「2.3 データ収集蓄積機
能」

3

データ項目紐付け機能

共有メモリーの番地と保存領域での番号との紐付けを行ない、時系列データを管理します。

「2.4 データ項目紐付け機能」

4

保存領域操作機能

保存領域上のデータに対し、取得・削除を行なう API 「2.5をサポートします。

5

データ名称定義機能

保存領域上のデータに対し、別名称の定義を可能とします。

「2.6 データ名称定義機
能」

6

RAS 機能異常発生時のイベントログへの出力や障害情報の収集をします。

「2.7

7

情報／状態表示機能

NX CDMS Embedded のプログラムプロダクト情 「2.8 情報／状態表示機
報、および NX CDMS Embedded の動作状態を表 能」
示するコマンドインターフェイスをサポートします。

8

インストーラ／アンイ
ンストーラ機能プログラムプロダクトのインストール、およびアン
インストールをサポートします。

保存領域操作機能」

RAS 機能」「2.9 インストーラ／アンインストーラ機能」

17

2

NX CDMS Embedded の機能

2.2

起動停止機能

ここでは、NX CDMS Embedded の起動停止機能について説明します。
NX CDMS Embedded の起動停止は、計算機の起動停止時のサービスの自動起動、自動停止で実施します。
計算機の起動停止以外に、定義ファイル変更時などの NX CDMS Embedded を起動、停止するための起動コマンド、および、停止コマンドを提供します。

18

起動コマンドの詳細については、「3.2起動コマンド」を参照してください。

停止コマンドの詳細については、「3.3

停止コマンド」を参照してください。

2

2.3

NX CDMS Embedded の機能

データ収集蓄積機能

ここでは、NX CDMS Embedded のデータ収集蓄積機能について説明します。
NX CDMS Embedded のデータ収集蓄積機能は、共有メモリー上に書き込まれた時系列データを、定周期、またはトリガー通知によって収集します。

19

2

NX CDMS Embedded の機能

図 2‒2 データ収集蓄積機能の概要図

共有メモリーに書き込まれた時系列データを保存領域に蓄積する際、データを間引く間隔をサンプリング周期と呼びます。

20

2

NX CDMS Embedded の機能

NX CDMS Embedded は時系列データを保存領域に蓄積する際、サンプリング周期の幅で最古の値を該当周期の値として蓄積します。
また、サンプリング周期が現場データの周期よりも小さい場合、現場データがないサンプリング周期の個所
はデータの欠落として扱います。
そのため、サンプリング周期は現場データの周期以上とすることを推奨します。
サンプリング周期について、次の図に示します。
図 2‒3

サンプリング周期

共有メモリーに設定されたトリガー通知に関係なく、常時収集するデータを定常監視データと呼びます。
定常監視データはサンプリング周期を 1 秒として、すべてのデータ項目を収集します。
トリガーで収集するデータには、エラートリガーによるデータ収集と、イベントトリガーによるデータ収集があります。
エラートリガーによって収集するデータをエラーログデータと呼びます。イベントトリガーによって収集するデータをイベントログデータと呼びます。
トリガーが発生した時刻を基準にさかのぼってデータを取得する期間を Before 期間、トリガーが発生した
時刻を基準にデータを取得し続ける期間を After 期間と呼びます。
トリガーによるデータ収集は、Before 期間と After 期間を合計した一定期間のデータを収集します。
この通知によって収集した一定期間のデータの集まりをロググループと呼びます。
一定期間のデータを収集する際、ロググループの先頭時刻とデータの時刻が一致する場合、そのデータは該
当ロググループに含まれます。
ロググループの末尾時刻とデータの時刻が一致する場合、そのデータは該当ロググループに含まれません。
ロググループについて、次の図に示します。

21

2

NX CDMS Embedded の機能

図 2‒4 ロググループ

エラーログデータは全データを収集対象とし、収集する期間は Before 期間が 4 秒、After 期間が 1 秒の計
5 秒間です。
また、エラーログデータのサンプリング周期は 4 ミリ秒です。
イベントログデータは、特定のデータだけ収集します。
イベントログデータの収集する期間、取得するデータ、サンプリング周期は、イベントトリガー定義ファイルで定義します。
定義ファイルの詳細については、「5.9イベントトリガー定義ファイル」を参照してください。

保存領域は、定常監視データ、エラーログデータとイベントログデータの 3 種類の領域に分かれています。
それぞれの領域に保存できるサイズの上限は 300MiB です。
上限に達した場合、定常監視データは、最古に登録したデータから順に上書きします。
エラーログデータとイベントログデータは、データの削除が実施されるまで保存は行なわれません。
不要になったデータをロググループ容量取得 API で確認し、定期的にロググループ削除 API で削除してください。
ロググループ削除 API、およびロググループ容量取得 API の詳細については、「4.6API」、および「4.7 ロググループ容量取得 API」を参照してください。

ロググループ削除

なお、共有メモリーへの書き込みの際にデータが欠落していた場合、NX CDMS Embedded は欠落している個所を 0 埋めした状態で保存領域に蓄積します。

22

2

2.4

NX CDMS Embedded の機能

データ項目紐付け機能

ここでは、NX CDMS Embedded のデータ項目紐付け機能について説明します。
NX CDMS Embedded のデータ項目紐付け機能は、共有メモリーのデータ項目と保存領域のデータ項目の対応付けを管理します。
対応付けが変更された場合、保存領域はすべて削除します。
共有メモリーのデータ項目と保存領域のデータ項目の対応付けは、データ項目紐付け定義ファイルで定義します。
詳細については、「5.6 データ項目紐付け定義ファイル」を参照してください。

23

2

NX CDMS Embedded の機能

2.5

保存領域操作機能

ここでは、NX CDMS Embedded の保存領域操作機能について説明します。
NX CDMS Embedded の保存領域操作機能は、保存領域を操作する API を提供します。提供する API の一覧、および詳細については、「4 保存領域操作 API」を参照してください。
保存領域操作 API を使ったアプリケーションを作成し、NX CDMS Embedded で蓄積したデータの参照、および不要になったエラーログデータ、イベントログデータを削除してください。
エラーログデータ、イベントログデータは、それぞれ 300MiB まで蓄積し、300MiB を超えるとデータの収集を停止します。
保存領域操作 API を使用して、不要になったエラーログデータ、イベントログデータを削除するようにしてください。

24

2

2.6

NX CDMS Embedded の機能

データ名称定義機能

ここでは、NX CDMS Embedded のデータ名称定義機能について説明します。
NX CDMS Embedded のデータ名称定義機能は、保存領域操作 API で指定する取得対象のデータ名称と保存領域のデータ項目との対応付けを管理します。
保存領域操作 API で指定する取得対象のデータ名称と保存領域のデータ項目との対応付けは、データ名称
定義ファイルで定義します。
詳細については、「5.7 データ名称定義ファイル」を参照してください。

25

2

NX CDMS Embedded の機能

2.7

RAS 機能

ここでは、NX CDMS Embedded の RAS 機能について説明します。
NX CDMS Embedded の RAS 機能は、障害発生時に解析に必要なログを出力します。
NX CDMS Embedded で出力するログは、イベントログだけです。
NX CDMS Embedded で出力するイベントログの詳細については、「6.1を参照してください。

Windows イベントログ一覧」

また、障害の原因を解析するために必要な情報を収集する RAS コマンドを提供します。
RAS コマンドの詳細については、「3.4

26

RAS コマンド」を参照してください。

2

2.8

NX CDMS Embedded の機能

情報／状態表示機能

ここでは、NX CDMS Embedded の情報／状態表示機能について説明します。
NX CDMS Embedded の情報／状態表示機能は、NX CDMS Embedded のプログラムプロダクト情報、および NX CDMS Embedded の動作状態を確認するコマンドを提供します。
プログラムプロダクト情報表示コマンドの詳細については、「3.5ド」を参照してください。
動作状態表示コマンドの詳細については、「3.6プログラムプロダクト情報表示コマン

動作状態表示コマンド」を参照してください。

27

2

NX CDMS Embedded の機能

2.9

インストーラ／アンインストーラ機能

ここでは、NX CDMS Embedded のインストーラ／アンインストーラ機能について説明します。

2.9.1

インストーラインストーラは、ファイルの作成、サービスの追加、および環境変数の設定を行います。

(1)

ファイル一覧
インストーラで作成するファイルを次に示します。
<NX CDMS Embedded インストールディレクトリ>(2)

サービス一覧
インストーラで作成するサービスを次の表に示します。
表 2‒2
項番
1

28

インストーラで追加するサービスの一覧
サービス名

表示名

備考

NX_CDMS_EMB_Service

NX_CDMS_EMB_Service

HX-DSM のサービス「HX_DSM_Manager」に依存関係を設定します。

2

(3)

NX CDMS Embedded の機能

環境変数一覧
インストーラで設定するシステム環境変数を次の表に示します。
表 2‒3

インストーラで設定するシステム環境変数の一覧

項番

変数名

設定内容

備考

1

PATH

NX CDMS Embedded インストールディ
レクトリ ¥bin

末尾に追加します。

2

NX_CDMS_EMB_DIR

NX CDMS Embedded インストールディ
レクトリ

デフォルト：C:¥NX-CDMSEMB

2.9.2

アンインストーラ

アンインストーラは、インストーラで作成したファイル、サービス、レジストリを削除します。環境変数の再設定は行いません。
インストール後に、インストーラで作成したフォルダ配下にファイルが新たに作成された場合、該当する
ファイル、およびフォルダは削除されません。

29

3

コマンド一覧
この章では、NX CDMS Embedded で提供する各種コマンドについて説明し
ます。

31

3

コマンド一覧

3.1

提供コマンド一覧

NX CDMS Embedded で提供するコマンドの一覧を次の表に示します。
表 3‒1
項番

32

提供コマンド一覧
コマンド

コマンド名称概要

参照先

1

起動コマンドcdms_emb_start.bat

NX CDMS Embedded を起動するコマンド「3.2

起動コマンド」2

停止コマンドcdms_emb_stop.bat

NX CDMS Embedded を停止するコマンド「3.3

停止コマンド」3

RAS コマンド

cdms_emb_ras.exe

障害解析に必要な情報を収集するコマンド「3.4

RAS コマンド」

4

プログラムプロダクト情報表示コマンドcdms_emb_info.bat

プログラムプロダクト情報を表示するコマンド「3.5 プログラムプロダク
ト情報表示コマンド」

5

動作状態表示
コマンド

cdms_emb_stat.exe

NX CDMS Embedded の動作状態を表示するコマンド「3.6 動作状態表示コマン
ド」

3

3.2

起動コマンド

3.2.1

コマンド形式

コマンド一覧

起動コマンドの形式を次に示します。
cdms_emb_start.bat

3.2.2

コマンドの説明起動コマンドを実行すると、NX CDMS Embedded サービスを開始します。

3.2.3

前提条件

起動コマンドの前提条件を次の表に示します。
表 3‒2

起動コマンドの前提条件

項番

項目

前提条件

1

NX CDMS
Embedded 稼働状態

NX CDMS Embedded サービスが停止している状態で実行してください。

2

実行ユーザー

管理者権限があるユーザーで実行してください。

3.2.4

戻り値

起動コマンドの戻り値を次の表に示します。
表 3‒3
項番

起動コマンドの戻り値一覧
戻り値

内容

条件

1

0

正常終了

NX CDMS Embedded サービスが開始しました。

2

1

多重起動エラー

NX CDMS Embedded サービスが停止していません。

管理者権限エラー

コマンド実行ユーザーに管理者権限が付与されていません。

3

3.2.5

メッセージ一覧

起動コマンドのメッセージ一覧を次の表に示します。
表 3‒4

起動コマンドのメッセージ一覧

項番

メッセージテキスト

説明

対処方法

1

NX CDMS Embedded startsuccess.

NX CDMS Embedded サービスの起動に成功しました。

−

2

NX CDMS Embedded isalready running.

NX CDMS Embedded サービスがすでに起動中です。

−

33

3

コマンド一覧

項番

メッセージテキスト

対処方法

3

This command needs to be
executed as Administrator.

管理者権限が付与されていないユーザーで実行しています。

管理者権限が付与されているユーザーで実行してください。

4

NX CDMS Embedded start
failed.

NX CDMS Embedded サービスの起動に失敗しました。

イベントログを確認して、「6Windows イベントログ」に記載されている対処を行ってください。

（凡例）−：対処不要

34

説明

3

3.3

停止コマンド3.3.1

コマンド形式

コマンド一覧

停止コマンドの形式を次に示します。
cdms_emb_stop.bat

3.3.2

コマンドの説明停止コマンドを実行すると、NX CDMS Embedded サービスを停止します。

3.3.3

前提条件

停止コマンドの前提条件を次の表に示します。
表 3‒5

停止コマンドの前提条件

項番

項目

前提条件

1

NX CDMS
Embedded 稼働状態

NX CDMS Embedded サービスが開始している状態で実行してください。

2

実行ユーザー

管理者権限があるユーザーで実行してください。

3.3.4

戻り値

停止コマンドの戻り値を次の表に示します。
表 3‒6
項番

停止コマンドの戻り値一覧
戻り値

内容

条件

1

0

正常終了

NX CDMS Embedded サービスが停止しました。

2

1

多重停止エラー

NX CDMS Embedded サービスが起動していません。

管理者権限エラー

コマンド実行ユーザーに管理者権限が付与されていません。

3

3.3.5

メッセージ一覧

停止コマンドのメッセージ一覧を次の表に示します。
表 3‒7

停止コマンドのメッセージ一覧

項番

メッセージテキスト

説明

対処方法

1

NX CDMS Embedded stop
success.

NX CDMS Embedded サービスの停止に成功しました。

−

2

NX CDMS Embedded is notrunning.

NX CDMS Embedded サービスが起動されていません。

−

35

3

コマンド一覧

項番

メッセージテキスト

対処方法

3

This command needs to be
executed as Administrator.

管理者権限が付与されていないユーザーで実行しています。

管理者権限が付与されているユーザーで実行してください。

4

NX CDMS Embedded stop
failed.

NX CDMS Embedded サービスの停止に失敗しました。

イベントログを確認して、「6Windows イベントログ」に記載されている対処を行ってください。

（凡例）−：対処不要

36

説明

3

3.4

RAS コマンド3.4.1

コマンド形式

コマンド一覧RAS コマンドの形式を次に示します。
cdms_emb_ras.exe [-out path ] [-level value ]オプションなし：

NX_CDMS_EMB_DIR ¥log ディレクトリ下にコマンド実行時刻「yyyyMMddHHmmss」という名称のディレクトリを作成し、出力します。
実行時刻を表示する変数と内容を次の表に示します。
表 3‒8

実行時刻表示文字と内容

項番

変数

内容

1

yyyy

西暦年

2

MM

月

3

dd

月に対する日

4

HH

時

5

mm

分

6

ss

秒

-out オプション：
path で指定した任意のディレクトリに出力します。path はフルパスで指定してください。ネットワー
クアドレスを含むパスは指定しないでください。
指定したディレクトリがない場合、指定したディレクトリを新規作成します。
指定したディレクトリがある場合、同名ファイルは上書き保存します。
-level オプション：
障害レベル（1,2）を指定します。障害レベルとは、障害解析に必要な情報ごとに設定されている値です。
このオプションは省略可能です。省略した場合、障害レベルを 1 として障害情報を収集します。
障害レベルと収集する情報の関係については、「3.4.2

3.4.2

コマンドの説明」を参照してください。

コマンドの説明RAS コマンドを実行すると、NX CDMS Embedded の障害解析に必要な情報を収集します。
収集する対象の情報を次の表に示します。
表 3‒9
項番
1

コマンドの収集情報一覧
収集対象
OS

収集情報
プロセス一覧

障害レベル
1

収集対象の情報tasklist -V の実行結果

37

3

コマンド一覧

項番

収集対象

障害

収集情報

収集対象の情報レベル2

環境変数一覧

set の実行結果

3

システム情報systeminfo の実行結果

4

Windows イベントログ

wevtutil の実行結果

5

NX CDMS
Embedded

NX CDMS Embedded のプログラ
ムプロダクト情報

1

cdms_emb_info.bat の実行結果

6

NX CDMS Embedded の動作情報

cdms_emb_stat.exe の実行結果

7

NX CDMS Embedded の定義情報

NX_CDMS_EMB_DIR ¥conf 下の定義
ファイル

8

NX CDMS Embedded の内部テー
ブル情報

NX CDMS Embedded のメモリーダ
ンプ

9

NX CDMS Embedded の保存領域

3.4.3

2

NX CDMS Embedded の保存領域

前提条件

RAS コマンドの前提条件を次の表に示します。
表 3‒10RAS コマンドの前提条件

項番

項目

前提条件

1

実行ユーザー

管理者権限があるユーザーで実行してください。

2

出力先空き容量

出力先ディレクトリに十分な空き容量を確保してください。
空き容量の目安
障害レベル 1 の場合：100MiB
障害レベル 2 の場合：1GiB

3.4.4

戻り値

RAS コマンドの戻り値を次の表に示します。
表 3‒11
項番

RAS コマンドの戻り値一覧
戻り値

内容

条件

1

0

正常終了

すべての障害情報の出力に成功しました。

2

1

オプションエラー

無効なオプションを指定しています。

出力エラー

ディレクトリの生成に失敗しました。

3

障害情報の出力に失敗しました。
438

管理者権限エラー

コマンド実行ユーザーに管理者権限が付与されていません。

3

3.4.5

コマンド一覧

メッセージ一覧

RAS コマンドのメッセージ一覧を次の表に示します。
表 3‒12
項番

RAS コマンドのメッセージ一覧
メッセージテキスト
Write to path completed.

1

説明
障害情報の出力に成功しました。

対処方法−

path ：
出力先のフルパス
2

The parameter is incorrect.

オプションの指定が誤っています。

オプションの指定を見直しの上、実行してください。

ディレクトリの生成に失敗しました。

path のパス名称を確認してくだ
さい。

Usage: cdms_emb_ras.exe [out path] [-level value]
Create path failed.

3

path ：
出力先のフルパス
Write to path failed.

4

障害情報の出力に失敗しました。

path ：
出力先のフルパス
5This command needs to be
executed as Administrator.

管理者権限が付与されていないユーザーで実行しています。

path のアクセス権を確認してください。
path の空き容量を確認してくだ
さい。
管理者権限が付与されているユーザーで実行してください。

（凡例）−：対処不要39

3

コマンド一覧

3.5

プログラムプロダクト情報表示コマンド

3.5.1

コマンド形式プログラムプロダクト情報表示コマンドの形式を次に示します。
cdms_emb_info.bat

3.5.2

コマンドの説明

プログラムプロダクト情報表示コマンドを実行すると、インストールされている NX CDMS Embedded
プログラムプロダクトの型式名称、バージョン、および SI 回数を表示します。

3.5.3

前提条件

プログラムプロダクト情報表示コマンドの前提条件を次の表に示します。
表 3‒13

プログラムプロダクト情報表示コマンドの前提条件

項番
1

3.5.4

項目

前提条件

実行ユーザー

管理者権限があるユーザーで実行してください。

戻り値

プログラムプロダクト情報表示コマンドの戻り値を次の表に示します。
表 3‒14
項番

プログラムプロダクト情報表示コマンドの戻り値一覧
戻り値

内容

条件

1

0

正常終了

プログラムプロダクト情報の表示に成功しました。

2

1

管理者権限エラー

コマンド実行ユーザーに管理者権限が付与されていません。

3.5.5

メッセージ一覧

プログラムプロダクト情報表示コマンドのメッセージ一覧を次の表に示します。
表 3‒15
項番
1

プログラムプロダクト情報表示コマンドのメッセージ一覧
メッセージテキスト[NX CDMS Embedded
Information]

プログラムプロダクト情報の表示に成功しました。

[P.P. Name] [Model][Version] [SI]si ：SI 回数

NX-CDMS-EMB S-741E-00Pver [si ]
2

40

説明

This command needs to be
executed as Administrator.

対処方法−

ver ：バージョン情報

管理者権限が付与されていないユーザーで実行しています。

管理者権限が付与されているユーザーで実行してください。

3

コマンド一覧

（凡例）−：対処不要41

3

コマンド一覧

3.6

動作状態表示コマンド

3.6.1

コマンド形式

動作状態表示コマンドの形式を次に示します。
cdms_emb_stat.exe

3.6.2

コマンドの説明

動作状態表示コマンドを実行すると、NX CDMS Embedded の動作状態を表示します。

3.6.3

前提条件

動作状態表示コマンドの前提条件を次の表に示します。
表 3‒16

動作状態表示コマンドの前提条件

項番
1

3.6.4

項目

前提条件

実行ユーザー

管理者権限があるユーザーで実行してください。

戻り値

動作状態表示コマンドの戻り値を次の表に示します。
表 3‒17項番

動作状態表示コマンドの戻り値一覧
戻り値

内容

条件

1

0

正常終了

動作状態の表示に成功しました。

2

1

管理者権限エラー

コマンド実行ユーザーに管理者権限が付与されていません。

3.6.5

メッセージ一覧

動作状態表示コマンドのメッセージ一覧を次の表に示します。
表 3‒18
項番
1

動作状態表示コマンドのメッセージ一覧
メッセージテキスト

説明[NX CDMS Embedded Status
Information]

動作状態の表示に成功しました。

[Name] [Status]
NX-CDMS-EMB status

対処方法−

status ：動作状態
STOP：停止中
INITIAL：初期化中
RUN：正常動作中
ERROR：異常発生中242This command needs to be
executed as Administrator.

管理者権限が付与されていないユーザーで実行しています。

管理者権限が付与されているユーザーで実行してください。

3

コマンド一覧

（凡例）−：対処不要43

4

保存領域操作 API
この章では、保存領域に蓄積したデータの参照や削除を行う API について説
明します。

45

4

保存領域操作 API

4.1

保存領域操作 API 一覧

NX CDMS Embedded は、保存領域に蓄積したデータの参照、および削除する API を提供します。
提供する API の一覧を次の表に示します。
表 4‒1
項番

46

提供する API の一覧
API 名

1

初期化 API2

終了処理 API

3

機能概要

参照先

保存領域操作 API の使用に係る初期化処理を行います。

「4.2

初期化 API」

保存領域操作 API の使用に係る終了処理を「4.3

終了処理 API」

定常監視データ読込 API

定常監視データから値を読み込みます。

「4.4 定常監視データ読込
API」

4

ロググループ読込 API

ロググループの値を読み込みます。

「4.5

ロググループ読込 API」

5

ロググループ削除 API

ロググループを削除します。

「4.6

ロググループ削除 API」

6

ロググループ容量取得
API

ロググループの容量を取得します。

「4.7 ロググループ容量取得
API」

行います。

4

4.2

保存領域操作 API

初期化 API

ここでは、初期化 API について説明します。

4.2.1

API の説明

初期化 API は、保存領域操作 API の使用に係る初期化処理を行います。
初期化処理が未実行の場合は初期化処理を実行し、実行済みの場合は何も行いません。

4.2.2

インターフェイス

int CDMS_EMB_WinInitialize(void);

4.2.3

戻り値

初期化 API の戻り値を次の表に示します。説明や対処方法については、「4.8
照してください。
表 4‒2
項番

リターンコード一覧」を参初期化 API の戻り値
リターンコード

値

1

CDMS_EMB_SUCCESS02

E_CDMS_EMB_NOTRUNNING-2

3

E_CDMS_EMB_GETENV

-102

4

E_CDMS_EMB_MEMORY

-103

47

4

保存領域操作 API

4.3

終了処理 API

ここでは、終了処理 API について説明します。

4.3.1

API の説明

終了処理 API は、保存領域操作 API の使用に係る終了処理を行います。
終了処理が未実行の場合は終了処理を実行し、実行済みの場合は何も行いません。

4.3.2

インターフェイス

int CDMS_EMB_WinFinalize(void);

4.3.3

戻り値

終了処理 API の戻り値を次の表に示します。説明や対処方法については、「4.8
参照してください。
表 4‒3
項番

48

リターンコード一覧」を終了処理 API の戻り値
リターンコード

値

1

CDMS_EMB_SUCCESS02

E_CDMS_EMB_NOTRUNNING

-2

4

4.4

保存領域操作 API

定常監視データ読込 API

ここでは、定常監視データ読込 API について説明します。

4.4.1

API の説明

定常監視データ読込 API は、定常監視データからデータ名および時刻を指定してデータを読み込みます。

4.4.2

インターフェイス

int CDMS_EMB_WinReadNormalLog(
const char**targets,size_tcount_targets,
int64_t
begin_timestamp,
int64_t
end_timestamp,
size_tmax_results,
int32_tflag_prioritize,
char**
results,size_t*count_results);

次の表に定常監視データ読込 API の引数一覧を示します。
表 4‒4

定常監視データ読込 API の引数一覧

項番

引数

種類

説明

1

targetsin取得対象とするデータ名の配列。

2

count_targetsin取得対象とするデータ名の件数。

3

begin_timestampin

開始時刻（0 の場合、無限遠の過去時刻を表すものとします）。

4

end_timestampin

終了時刻（0 の場合、無限遠の未来時刻を表すものとします）。

5

max_resultsin

読み込み件数の上限値。

6

flag_prioritizein

読み込み可能なデータの件数が読み込み件数の上限値を超える場合に、開始時刻側か終了時刻側のどちらに寄せて読み込むかを指定します。
• BEGIN_TIME を指定した場合、開始時刻側に寄せてデータを読み込みます。
• END_TIME を指定した場合、終了時刻側に寄せてデータを読み
込みます。

7

resultsout

データ名とタイムスタンプに対応する値の二次元配列。データ時刻の昇順でソートします。
二次元配列のイメージを「表 4‒5 定常監視データ読込 API の引数
results の二次元配列イメージ」に示します。

8

count_results

out

結果の件数。

定常監視データ読込 API の引数 results の二次元配列イメージを次の表に示します。

49

4

保存領域操作 API

表 4‒5

定常監視データ読込 API の引数 results の二次元配列イメージ

件数
1 件目

データ時刻
2019/08/01 10:00:00.000

データ名 1…

123

データ名 Y

…

aaa

…

ccc

…
X 件目

2019/08/01 10:00:10.000

456

（凡例）
…：省略を表す。
X の値が結果の件数（count_results）、Y の値がデータ名の件数（count_targets）になります。各データは、一つ当たり 8 バイトとして扱います。

4.4.3

戻り値

定常監視データ読込 API の戻り値を次の表に示します。説明や対処方法については、「4.8
ド一覧」を参照してください。
表 4‒6
項番

50

定常監視データ読込 API の戻り値
リターンコード

値

1

CDMS_EMB_SUCCESS02

E_CDMS_EMB_NOTREADY-13

E_CDMS_EMB_NOTRUNNING-24

E_CDMS_EMB_NORECORDS-135

E_CDMS_EMB_INVALIDARGUMENT-14

リターンコー4

4.5

保存領域操作 API

ロググループ読込 API

ここでは、ロググループ読込 API について説明します。

4.5.1

API の説明

ロググループ読込 API は、基点時刻を指定して、指定時刻に最も近いロググループを読み込みます。

4.5.2

インターフェイス

int CDMS_EMB_WinReadLogGroup(
int32_tflag_target,
int64_t
begin_timestamp,
int32_tflag_direction,
char**
results,size_t*count_results);

次の表にロググループ読込 API の引数一覧を示します。
表 4‒7

ロググループ読込 API の引数一覧

項番
1

引数

種類

flag_targetin

説明
取得対象とするトリガー。
ERROR_TRIGGER, EVENT_TRIGGER_X（X は 1〜16 が入る）のいずれかのマクロを指定します。

2begin_timestampin

ロググループを取得する際の基点となる時刻。

3

flag_directionin

基点となる時刻より未来の時刻で近いロググループを取得するか、過去の時刻で近いロググループを取得するか指定します。
• POSTIVE を指定した場合、基点の時刻より未来の時刻のロググ
ループを取得します。
• NEGATIVE を指定した場合、基点の時刻より過去の時刻のログ
グループを取得します。

4

resultsout

読み込んだデータの二次元配列。データ時刻の昇順でソートします。
二次元配列のイメージを「表 4‒8 ロググループ読込 API の引数
results の二次元配列イメージ」に示します。

5

count_results

out

結果の件数。

ロググループ読込 API の引数 results の二次元配列イメージを次の表に示します。
表 4‒8

ロググループ読込 API の引数 results の二次元配列イメージ

件数
1 件目

データ時刻
2019/08/01 10:00:00.000

Data1
123

…

DataN

…

aaa

…

ccc

…
X 件目

2019/08/01 10:00:10.000

456

（凡例）
…：省略を表す。

51

4

保存領域操作 API

X の値が結果の件数（count_results）です。Data1 から DataN には、取得したデータ項目を、次に示す順にソートして格納します。
• ERROR_TRIGGER を対象とした場合、データ項目紐づけ定義ファイルの Data セクション順（昇順）• EVENT_TRIGGER_X を対象とした場合、イベントトリガー定義ファイルの該当イベントトリガーセ
クションの TargetData キーに記載した順
各データは、一つ当たり 8 バイトとして扱います。

4.5.3

戻り値

ロググループ読込 API の戻り値を次の表に示します。説明や対処方法については、「4.8一覧」を参照してください。
表 4‒9
項番

52

ロググループ読込 API の戻り値
リターンコード

値

1

CDMS_EMB_SUCCESS02

E_CDMS_EMB_NOTREADY-13

E_CDMS_EMB_NOTRUNNING-24

E_CDMS_EMB_NORECORDS-135

E_CDMS_EMB_INVALIDARGUMENT-146

E_CDMS_EMB_MEMORY-103

リターンコード

4

4.6

保存領域操作 API

ロググループ削除 API

ここでは、ロググループ削除 API について説明します。

4.6.1

API の説明

ロググループ削除 API は、ロググループ ID を指定して、ロググループを削除します。
ロググループ ID は、ロググループ容量取得 API で削除対象のロググループを確認して指定してください。
同一ロググループ ID に対して、ロググループ削除 API を複数の処理から同時実行しないでください。

4.6.2

インターフェイス

int CDMS_EMB_WinDeleteLogGroup(
int32_tflag_target,
uint64_tloggroup_id);

次の表にロググループ削除 API の引数一覧を示します。
表 4‒10

ロググループ削除 API の引数一覧

項番
1

引数

種類

flag_targetin

説明
削除対象とするトリガー。
DELETE_ERROR_TRIGGER または DELETE_EVENT_TRIGGERのいずれかのマクロを指定します。

2

4.6.3

loggroup_id

in

削除対象とするロググループ ID。

戻り値

ロググループ削除 API の戻り値を次の表に示します。説明や対処方法については、「4.8一覧」を参照してください。
表 4‒11
項番

リターンコード

ロググループ削除 API の戻り値
リターンコード

値

1

CDMS_EMB_SUCCESS02

E_CDMS_EMB_NOTREADY-13

E_CDMS_EMB_NOTRUNNING-24

E_CDMS_EMB_IDNOTFOUND-115

E_CDMS_EMB_GATHERING-126

E_CDMS_EMB_INVALIDARGUMENT

-14

53

4

保存領域操作 API

4.7

ロググループ容量取得 API

ここでは、ロググループ容量取得 API について説明します。

4.7.1

API の説明

ロググループ容量取得 API は、ログ容量の一覧を取得します。

4.7.2

インターフェイス

int CDMS_EMB_WinLogStatistics(
const int32_t
flag_target,
const uint64_t
max_results,
uint64_t*
total_results,
struct loggroup_info* results,
uint64_t*
count_results);
struct loggroup_info {uint64_tloggroup_id;
int64_ttimestamp;
size_tsize;};

次の表にロググループ容量取得 API の引数一覧を示します。
表 4‒12

ロググループ容量取得 API の引数一覧

項番
1

引数

種類

flag_targetin

説明
取得対象とするトリガー。
ERROR_TRIGGER または EVENT_TRIGGER_X（X は 1〜16 が入る）のいずれかのマクロを指定します。

2

max_resultsin

ログ容量取得結果として確保した件数。

3

total_resultsout

取得対象に指定したトリガーが持つロググループ ID の総数。

4

resultsout

ログ容量取得結果の 1 次元配列。
構造体 loggroup_info を配列で、最大ログ容量取得結果として確保した件数分格納します。
構造体 loggroup_info の詳細は、「表 4‒13 ロググループ容量取得
API の取得結果の構造」を参照してください。
ロググループ ID の昇順（トリガー発生時刻が古い順）にソートします。

5count_results

out

結果の件数。

ログ容量取得結果の１次元配列の構造を次の表に示します。
表 4‒13

ロググループ容量取得 API の取得結果の構造

項番

54

引数

説明

1

loggroup_id

ロググループ ID。

2timestamp

トリガー発生時刻。

3size

ロググループの容量（Byte）。

4

4.7.3

保存領域操作 API

戻り値

ロググループ容量取得 API の戻り値を次の表に示します。説明や対処方法については、「4.8
コード一覧」を参照してください。
表 4‒14
項番

リターン

ロググループ容量取得 API の戻り値
リターンコード

値

1

CDMS_EMB_SUCCESS02

E_CDMS_EMB_NOTREADY-13

E_CDMS_EMB_NOTRUNNING-24

E_CDMS_EMB_NORECORDS-135

E_CDMS_EMB_INVALIDARGUMENT

-14

55

4

保存領域操作 API

4.8

リターンコード一覧

保存領域操作 API が戻り値として返すリターンコードの一覧を次の表に示します。
表 4‒15
項番

56

保存領域 API のリターンコード一覧
リターンコード

値

説明

対処方法

1

CDMS_EMB_SUCCE
SS

0

正常終了しました。

対処は不要です。

2

E_CDMS_EMB_NOT
READY

-1

保存領域の初期化が未完了です。

保存領域の初期化 API（4.2 初期
化 API）をコールしてから、再度実行してください。

3

E_CDMS_EMB_NOTRUNNING-2

NX CDMS Embedded のサービスが停止しています。

起動コマンド（3.2 起動コマンド）を実行してから、再度実行してくだ
さい。

4

E_CDMS_EMB_IDN
OTFOUND-11

引数で指定したロググループ
ID が見つかりません。

指定するロググループ ID は、ロググループ容量取得 API（4.7 ログ
グループ容量取得 API）で取得した
ID を指定してください。

5

E_CDMS_EMB_GATHERING-12

引数で指定したロググループ
ID はデータ収集中です。

指定するロググループ ID は、ロググループ容量取得 API（4.7 ログ
グループ容量取得 API 参照）で取得した ID を指定してください。

6

E_CDMS_EMB_NOR
ECORDS-13

引数で指定した条件のレコードが見つかりません。

引数を見直し、再度実行してください。

7

E_CDMS_EMB_INVA
LIDARGUMENT-14

引数に誤りがあります。

引数を見直し、再度実行してください。

8

E_CDMS_EMB_REA
DING

-15

ファイルを読み込み中です。

ロググループ読込 API（「4.5 ログ
グループ読込 API」参照）やロググ
ループ容量取得 API（「4.7 ロググ
ループ容量取得 API」参照）の実行が完了した後、再度実行してください。

9

E_CDMS_EMB_INTE
RNAL

-101

内部エラーが発生しました。

RAS コマンドを使用して障害レベ
ルが、1 と 2 の障害情報を収集の上、問い合わせ窓口へご連絡ください。

10

E_CDMS_EMB_GET
ENV

-102

環境変数が見つかりません。
NX CDMS Embedded が正常にインストールされていません。

NX CDMS Embedded をアンイ
ンストール後、再度インストールしてください。

11

E_CDMS_EMB_MEM
ORY

-103

API 実行のためのメモリーが不足しています。

NX CDMS Embedded の実行に必要なメモリーを確保してから、再度実行してください。

5

定義ファイル
この章では、NX CDMS Embedded で使用する定義ファイルについて説明し
ます。

57

5

定義ファイル

5.1

定義ファイル一覧

NX CDMS Embedded で使用する定義ファイルの一覧を次の表に示します。
表 5‒1

定義ファイルの一覧

項番

定義ファイル名

定義内容

1

データ用リングバッファ定義
ファイル

データ項目として使用する共有メモリーのリングバッファの構造を定義します。

「5.5 データ用リングバッ
ファ定義ファイル」

2

データ項目紐付け定義ファイル

共有メモリーのデータ項目と保存領域のデータ項目の対応付けを定義します。

「5.6 データ項目紐付け定義
ファイル」

3

データ名称定義ファイル

保存領域操作 API で指定する取得対象の 「5.7 データ名称定義ファイ
データ名称と保存領域のデータ項目の対ル」
応付けを定義します。

4

トリガー用リングバッファ定義ファイル

トリガーの通知、およびトリガーの動作
状態を連携するために使用するリング
バッファの構造を定義します。

「5.8 トリガー用リングバッ
ファ定義ファイル」

5

イベントトリガー定義ファイル

イベントトリガーで収集するデータ項
目、サンプリング周期、および収集期間を定義します。

「5.9 イベントトリガー定義
ファイル」

各定義ファイルの定義内容の概要を次の図に示します。

58

参照先

5

図 5‒1

定義ファイル

定義ファイルの定義内容の概要説明

59

5

定義ファイル

5.2

定義ファイルにおける注意事項

定義ファイルの注意事項を次の表に示します。
表 5‒2
項番
1

定義ファイルの注意事項
制約内容

対処方法

NX CDMS Embedded で使用する定義ファイルは
先頭 1 行目がコメント行でなければなりません。

定義ファイルは、サンプルファイルを編集して使用してください。なお、ユーザーが定義ファイルを最初からエディターで作成する場合は、定義ファイルの先頭 1 行目をコメント行としてください。

コメント行でない場合、定義エラー扱いとなる場合があります。

60（Windows のメモ帳（notepad.exe）で UTF-8 ファ
イルを作成した場合、無条件で BOM 付きファイルとなります。この形式の場合、一部の API ではエンコードを正しく取り扱えない問題が発生しますが、先頭 1 行目をコメント行とすることで回避できます。）

2

範囲外の数値、使用不可の文字を指定した場合、NX
CDMS Embedded の起動は失敗します。

範囲外の数値、使用不可の文字は指定しないでくだ
さい。

3

データ用リングバッファ定義ファイルとトリガー用
リングバッファ定義ファイルの定義内容は、HXDSM の定義ファイルの定義内容と一致させてくだ
さい。

−

4

イベントトリガー定義ファイルとデータ名称定義
ファイルのデータ名称は一致させてください。

−

5

5.3

定義ファイル

定義ファイルの共通仕様

定義ファイルの共通仕様を次の表に示します。
表 5‒3
項番

定義ファイルの共通仕様
内容1

定義ファイルは、Windows の ini ファイルの仕様に準拠します。

2

重複した同名のセクションを定義した場合は、行番号の小さいセクションを優先します。

3セクション内で同名の定義項目を定義した場合は、行番号の小さい定義項目を優先します。

4

コメント行にする場合は、行の先頭に";"をつけてください。
行の途中に";"をつけてもコメント扱いとなりません。

5セクションでは、定義項目に対し"="でパラメータを指定します。

6

各定義項目に対し、使用可能文字以外の文字を指定した場合および範囲を超えて指定した場合、NX CDMS
Embedded の起動は失敗します。

61

5

定義ファイル

5.4

定義ファイルの配置場所

サンプルの定義ファイルの配置場所を示します。
NX_CDMS_EMB_DIR \sample\

作成した定義ファイルの配置場所を示します。
NX_CDMS_EMB_DIR \conf\

62

5

5.5

データ用リングバッファ定義ファイル

5.5.1

ファイルの説明

定義ファイル

データ用リングバッファ定義ファイルでは、データ項目として使用するリングバッファの構造を定義します。
ファイルが存在しない場合、NX CDMS Embedded の起動は失敗します。

5.5.2

ファイル名称

データ用リングバッファ定義ファイルの名称を示します。
cdms_emb_dataring.conf

5.5.3

定義記述方法

データ用リングバッファ定義ファイルの記述形式を説明します。

(1)

記述形式
各リングバッファについて定義する「RingBuffer」セクションから構成されます。
RingBuffer セクションの定義の詳細については、「(2)RingBuffer セクション」を参照してください。

;Caution!! Don't delete this message.
[RingBuffer1]
BuffName=リングバッファ名称
BlockSize=ブロックサイズ
Hash=ハッシュコード[RingBuffer2]
RingBuffer2の定義
・・・[RingBufferN]
RingBufferNの定義

参考• 「RingBuffer」セクションに付加する番号に対しての定義順番の制限はありません。番号は連番にする必要はありません。
定義位置の場所に関わらず、「RingBuffer1、RingBuffer2、・・・、RingBufferN」の順番で定義項目を取り
込みます。

(2)

RingBuffer セクション
各リングバッファに関わる定義を行ないます。
RingBuffer セクションの名称に「1〜100」の範囲内の番号（10 進数表記）を付加して、セクション名としてください。
RingBuffer セクションの名称の番号が範囲外の場合、該当する RingBuffer セクションは無視します。
セクションの定義や必須の定義項目がない場合、NX CDMS Embedded の起動は失敗します。

63

5

定義ファイル

表 5‒4
項番
1

RingBuffer セクション定義項目
定義項目
BuffName

説明
HX-DSM で定義したリングバッファ名称を記述します。

設定要否
必須

使用不可文字を指定した場合はエラーとします。
• 文字数：1〜31 文字（32 文字目以降は無視します。）• 使用可能文字：英数字、"_"、"-"
2

BlockSize

HX-DSM で定義したリングバッファにおける 1 ブロックあたりのサイズを記述します。

必須• 範囲：8〜2147483647
3

Hash

HX-DSM で定義したハッシュコードを記述します。
• 範囲：0x00000000〜0xFFFFFFFF（0x の後に 16 進文字
列）

64

必須

5

5.6

データ項目紐付け定義ファイル

5.6.1

ファイルの説明

定義ファイル

データ項目紐付け定義ファイルでは、共有メモリーのデータ項目と保存領域のデータ項目の対応付けを定義します。
ファイルが存在しない場合、NX CDMS Embedded の起動は失敗します。

5.6.2

ファイル名称データ項目紐付け定義ファイルの名称を記載します。
cdms_emb_mapped.conf

5.6.3

定義記述方法データ項目紐付け定義ファイルの記述形式を説明します。

(1)

記述形式
データ項目全体について定義する「Common」セクションと、各データ項目について定義する「Data」セ
クションから構成されます。
各セクション定義の詳細については、「(2)
照してください。

Common セクション」および「(3)Data セクション」を参;Caution!! Don't delete this message.
[Common]HashCode=ハッシュコード[Data1]
BuffName=リングバッファ名称
DataTopPtr=データの相対先頭アドレス
DataSize=データのサイズ[Data2]

Data2の定義
・・・[DataN]
DataNの定義

参考• 「Data」セクションに付加する番号に対しての定義順番の制限はありません。番号は連番にする必要はありません。
定義位置の場所に関わらず、「Data1、Data2、・・・、DataN」の順番で定義項目を取り込みます。

(2) Common セクション
データ項目全体に関わる定義を行ないます。
セクションの定義や必須の定義項目がない場合、NX CDMS Embedded の起動は失敗します。

65

5

定義ファイル

表 5‒5
項番
1

Common セクション定義項目
定義項目
HashCode

説明
ハッシュコードを記述します。

設定要否
必須

ハッシュコードを変更すると、保存領域はすべて削除されます。
Data セクション内を編集した場合は、必ずハッシュコードを別の値に変更してください。
• 範囲：0x00000000〜0xFFFFFFFF（0x の後に 16 進文字列）(3)Data セクション
各データ項目に関わる定義を行ないます。
Data セクションの名称に「1〜1000」の範囲内の番号（10 進数表記）を付加して、セクション名としてください。
Data セクション名称の番号が範囲外の場合、該当する Data セクションは無視します。
セクションを定義して必須の定義項目がない場合、NX CDMS Embedded の起動は失敗します。
表 5‒6
項番
1

Data セクション定義項目
定義項目
BuffName

説明
HX-DSM で定義したリングバッファ名称を記述します。

設定要否
必須

使用不可文字を指定した場合はエラーとします。
• 文字数：1〜31 文字（32 文字目以降は無視します。）• 使用可能文字：英数字、"_"、"-"
2

DataTopPtr

リングバッファのブロック内におけるデータの相対先頭アドレスを記述します。

必須

各ブロックにおいて、先頭 8 バイトは時刻の格納領域になりますので、8 バイト目以降を指定してください。
• 範囲：8〜2147483647
3

DataSize

データのサイズを記述します。
• 範囲：1〜8

66

必須

5

5.7

データ名称定義ファイル

5.7.1

ファイルの説明

定義ファイル

データ名称定義ファイルでは、保存領域操作 API で指定する取得対象のデータ名称と保存領域のデータ項
目との対応付けを定義します。
ファイルが存在しない場合、NX CDMS Embedded の起動は失敗します。

5.7.2

ファイル名称

データ名称定義ファイルの名称を示します。
cdms_emb_named.conf

5.7.3

定義記述方法

データ名称定義ファイルの記述形式を記載します。

(1)

記述形式
データ名称について定義する「Aliases」セクションから構成されます。
Aliases セクション定義の詳細については、「(2)Aliases セクション」を参照してください。

;Caution!! Don't delete this message.
[Aliases]
データ名称 =Data1
データ名称 =Data1
データ名称 =Data2
・・・
データ名称 =Data1000

参考• 一つのデータ項目に対し、複数のデータ名称を定義することができます。

(2)

Aliases セクション
データ名称に関わる定義を行ないます。
データ名称を定義しない場合、データ名称にはデータ項目紐付け定義ファイルの Data セクション名を使用
します。
表 5‒7
項番
1

Aliases セクション定義項目
定義項目

データ名称

説明
左辺：

設定要否
任意

任意のデータ名称を指定します。
データ名称は NX CDMS Embedded 内で一意となるようにしてください。
• 文字数：1〜31 文字

67

5

定義ファイル

項番

定義項目

説明
• 使用可能文字：英数字、"_"、"-"
右辺：
データ項目紐付け定義ファイルの Data セクション名を指定します。
データ項目紐付け定義ファイルに定義していないセクショ
ン名を指定した場合、NX CDMS Embedded の起動は失敗します。
• 範囲：Data1〜Data1000

68

設定要否

5

5.8

トリガー用リングバッファ定義ファイル

5.8.1

ファイルの説明

定義ファイルトリガー用リングバッファ定義ファイルでは、トリガーの通知、およびトリガーの動作状態を連携するために使用するリングバッファの構造を定義します。
ファイルが存在しない場合、NX CDMS Embedded の起動は失敗します。

5.8.2

ファイル名称

トリガー用リングバッファ定義ファイルの名称を示します。
cdms_emb_triggerring.conf

5.8.3

定義記述方法

トリガー用リングバッファ定義ファイルの記述形式を示します。

(1)

記述形式
トリガー用リングバッファ定義ファイルは、次のセクションから構成されます。
「TriggerStatus」セクション
トリガーの動作状態を連携するために使用するリングバッファの構造を定義します。
「ErrTrigger」セクション
エラートリガーを通知するために使用するリングバッファの構造を定義します。
「EvtTrigger」セクション
イベントトリガーを通知するために使用するリングバッファの構造を定義します。
各セクションの構造を定義する詳細については、「(2) TriggerStatus セクション」、「(3)クション」、および「(4) EvtTrigger セクション」を参照してください。

ErrTrigger セ;Caution!! Don't delete this message.
[TriggerStatus]
BuffName=TRIGGER_STAT
BlockSize=ブロックサイズ
Hash=ハッシュコード[ErrTrigger]
BuffName=ERR_TRIGGER
BlockSize=16
Hash=ハッシュコード[EvtTrigger1]
BuffName=EVT_TRIGGER_1
BlockSize=16
Hash=ハッシュコード[EvtTrigger2]

EvtTrigger2の定義
・・・[EvtTriggerN]
EvtTriggerNの定義

参考• 「EvtTrigger」セクションに付加する番号に対しての定義順番の制限はありません。番号は連番にする必要はありません。

69

5

定義ファイル

定義位置の場所に関わらず、「EvtTrigger1、EvtTrigger2、・・・、EvtTriggerN」の順番で定義項目を取り
込みます。

(2)

TriggerStatus セクション
トリガーの動作状態を連携するために使用するリングバッファの構造に関わる定義を行ないます。
セクションの定義や必須の定義項目がない場合、NX CDMS Embedded の起動は失敗します。
表 5‒8
項番

TriggerStatus セクション定義項目
定義項目

説明

設定要否

1

BuffName

リングバッファ名称は、「TRIGGER_STAT」固定です。

必須

2

BlockSize

リングバッファにおける 1 ブロックあたりのサイズは、
「32」固
定です。

必須

3

Hash

HX-DSM で定義したハッシュコードを記述します。

必須• 範囲：0x00000000〜0xFFFFFFFF（0x の後に 16 進文字列）(3)

ErrTrigger セクション
エラートリガーを通知するために使用するリングバッファの構造に関わる定義を行ないます。
セクションの定義や必須の定義項目がない場合、NX CDMS Embedded の起動は失敗します。
表 5‒9
項番

ErrTrigger セクション定義項目
定義項目

説明

設定要否

1

BuffName

リングバッファ名称は、「ERR_TRIGGER」固定です。

必須

2

BlockSize

リングバッファにおける 1 ブロックあたりのサイズは、
「16」固
定です。

必須

3

Hash

HX-DSM で定義したハッシュコードを記述します。

必須• 範囲：0x00000000〜0xFFFFFFFF（0x の後に 16 進文字列）(4)

EvtTrigger セクション
イベントトリガーを通知するために使用するリングバッファの構造に関わる定義を行ないます。
EvtTrigger セクションの名称に「1〜16」の範囲内の番号（10 進数表記）を付加して、セクション名としてください。
EvtTrigger セクション名称の番号が範囲外の場合、該当 EvtTrigger セクションは無視します。
セクションを定義して必須の定義項目がない場合、NX CDMS Embedded の起動は失敗します。
表 5‒10
項番
1

70

EvtTrigger セクション定義項目
定義項目
BuffName説明
リングバッファ名称は、「EVT_TRIGGER_N 」固定です。

設定要否
必須

5

項番

定義項目

説明

定義ファイル

設定要否

N は、EvtTrigger セクションの名称に付加した番号（10 進数表
記）と同じ番号を指定してください。
2

BlockSize

リングバッファにおける 1 ブロックあたりのサイズは、
「16」固
定です。

必須

3

Hash

HX-DSM で定義したハッシュコードを記述します。

必須• 範囲：0x00000000〜0xFFFFFFFF（0x の後に 16 進文字列）71

5 定義ファイル

5.9

イベントトリガー定義ファイル

5.9.1

ファイルの説明イベントトリガー定義ファイルでは、イベントトリガーで収集するデータ項目、サンプリング周期、および収集期間を定義します。
ファイルが存在しない場合、NX CDMS Embedded の起動は失敗します。

5.9.2

ファイル名称

イベントトリガー定義ファイルの名称を示します。
cdms_emb_trigger.conf

5.9.3

定義記述方法イベントトリガー定義ファイルの記述形式を説明します。

(1)

記述形式
各イベントトリガーについて定義する「EventTrigger」セクションから構成されます。
EventTrigger セクション定義の詳細については、「(2)EventTrigger セクション」を参照してください。

;Caution!! Don't delete this message.
[EventTrigger1]
TargetData=データ名称
SampCyc=サンプリング周期
BeforeTime=Before期間
AfterTime=After期間
Hash=ハッシュコード[EventTrigger2]

EventTrigger 2の定義
・・・
[EventTrigger N]
EventTrigger Nの定義

参考• 「EventTrigger」セクションに付加する番号に対しての定義順番の制限はありません。番号は連番にする必要はありません。
位置の場所に関わらず、「EventTrigger 1、EventTrigger 2、・・・、EventTrigger N」の順番で定義項目を取り込みます。

(2)

EventTrigger セクション
各イベントトリガーに関わる定義を行ないます。
EventTrigger セクションの名称に「1〜16」の範囲内の番号（10 進数表記）を付加して、セクション名としてください。
EventTrigger セクション名称の番号が範囲外の場合、該当 EventTrigger セクションは無視します。
セクションを定義して必須の定義項目がない場合、NX CDMS Embedded の起動は失敗します。

72

5

表 5‒11
項番
1

定義ファイルEventTrigger セクション定義項目
定義項目
TargetData

説明
イベントトリガーの対象としたいデータ項目を、データ名称定義ファイルで定義したデータ名称で記述します。

設定要否
必須

存在しないデータ名称を指定した場合、NX CDMS Embeddedの起動は失敗します。
• 区切り文字：","• データ数：1〜16• 1 データ名称あたりの文字数：1〜31 文字• 使用可能文字：英数字、"_"、"-"
2

SampCyc

データを間引く間隔（ミリ秒単位）を記述します。

必須• 範囲：1〜2147483647
3

BeforeTime

トリガーが発生した時刻を基準に遡ってデータを取得する期間（ミリ秒単位）を記述します。

必須• 範囲：0〜4000
4

AfterTime

トリガーが発生した時刻を基準にデータを取得し続ける期間（ミリ秒単位）を記述します。

必須• 範囲：0〜2147483647
5

Hash

ハッシュコードを記述します。ハッシュコードを変更すると、該当するイベントトリガーのデータは削除されます。
EventTrigger セクション内を編集した場合は、必ずハッシュ
コードを別の値に変更してください。

必須• 範囲：0x00000000〜0xFFFFFFFF（0x の後に 16 進文字
列）

73

6

Windows イベントログ
この章では、Windows イベントログについて説明します。

75

6

Windows イベントログ

6.1

Windows イベントログ一覧

Windows イベントログに出力されるメッセージ内容と対処方法について、次の表に示します。
表 6‒1

Windows イベントログ一覧

項番

イベント ID

1

100

レベル
情報

内容
【メッセージテキスト】
Started NX CDMS Embedded.
【説明】
NX CDMS Embedded が起動しました。
【対処方法】
−

2

101

情報

【メッセージテキスト】
Stopped NX CDMS Embedded.
【説明】
NX CDMS Embedded が停止しました。
【対処方法】
−

3

102

情報

【メッセージテキスト】
Warning recovered.
【説明】
警告状態から回復しました。
【対処方法】
−

4

103

情報

【メッセージテキスト】
Storage area deleted.(Area=name )【説明】
定義ファイルの変更を検知したので、保存領域を削除しました。

name ：All または EventTriggerN (N ：1〜16)【対処方法】
−
5

600

警告

【メッセージテキスト】
Warning occurred.(RingBuffer=name )【説明】
データの欠落を検知しました。

name ：リングバッファ名称【対処方法】
共有メモリーにデータが書き込まれていません。共有メモリーにデータを書き込んでいるか確認してください。
6

601

警告

【メッセージテキスト】
Storage area fulled.(Area=type )【説明】
保存領域の容量が上限に達しました。

76

6

項番

イベント ID

レベル

Windows イベントログ

内容type ：Error、または Event【対処方法】「4.6 ロググループ削除 API」を参照の上、該当する保存領域のデータを削除してください。
7

994

エラー

【メッセージテキスト】
Configuration was inconsistent with HX-DSM. (File=name ,BuffName=buff , HX-DSM=size )【説明】
定義ファイルと HX-DSM のブロックサイズが不整合です。

name ：ファイル名称
buff ：リングバッファ名称
size ：HX-DSM のブロックサイズ【対処方法】
該当の定義項目を修正した後、再起動してください。
8

995

エラー

【メッセージテキスト】
Internal Process exit abnormally.(エラーの詳細情報 )【説明】
内部プロセスの異常終了を検知しました。
【対処方法】
他のエラーの Windows イベントログが出力されているか確認してください。
出力がない場合は、RAS コマンドで障害レベルが 1 の障害情報を収集した後、問い合わせ窓口へご連絡ください。RAS コマンドは、「3.4
RAS コマンド」を参照してください。

9

996

エラー

【メッセージテキスト】
HX-DSM Error.(Func=name , Rtn=num )【説明】
HX-DSM でエラーが発生しました。

name ：関数名称
num ：関数の戻り値【対処方法】HX-DSM のマニュアルを参照の上、対処してください。
10

997

エラー

【メッセージテキスト】
Configuration Error.(File=name , Section=section , Key=key )【説明】
定義ファイルが誤っています。

name ：ファイル名称
section ：セクション名称
key ：キー名称【対処方法】
該当の定義項目を修正した後、再起動してください。
11

998

エラー

【メッセージテキスト】
API Error.(Func=name , Return=value )77

6Windows イベントログ

項番

イベント ID

レベル

内容
【説明】
保存領域操作 API でエラーが発生しました。

name ：関数名称
value ：リターンコード【対処方法】

value の値は、「4.8 リターンコード一覧」を参照して対処してくださ
い。
12

999

エラー

【メッセージテキスト】
Internal Error.(エラーの詳細情報 )【説明】
内部処理で異常が発生しました。
【対処方法】RAS コマンドで障害レベルが 1 の障害情報を収集した後、問い合わせ
窓口へご連絡ください。
RAS コマンドは、「3.4（凡例）−：対処不要78

RAS コマンド」を参照してください。

7

保存領域操作 API を使ったアプリ
ケーション作成
この章では、保存領域操作 API を使ったアプリケーションの作成について説
明します。

79

7

保存領域操作 API を使ったアプリケーション作成

7.1

インクルードファイル

アプリケーション作成に必要なインクルードファイルの配置場所を次に示します。
NX_CDMS_EMB_DIR \inc\usr\cdms_emb_utility.h
NX_CDMS_EMB_DIR \inc\sys\cdms_emb_return_codes.h
NX_CDMS_EMB_DIR \lib\cdms_emb_storage.lib

ヘッダファイルの内容は、変更しないでください。

80

7

7.2

保存領域操作 API を使ったアプリケーション作成

DLL（Dynamic Link Library）

アプリケーションの動作に必要な DLL の配置場所を、次に示します。
NX_CDMS_EMB_DIR \bin\cdms_emb_storage.dll

81

7

保存領域操作 API を使ったアプリケーション作成

7.3

作成環境

NX CDMS Embedded のインクルードファイルおよび DLL は、Visual Studio 2015 で作成しています。
保存領域操作 API を使用したアプリケーションは、Visual Studio 2015 以降を使用して作成してくださ
い。

82

7

7.4

保存領域操作 API を使ったアプリケーション作成

保存領域操作 API 使用時の注意事項

保存領域操作 API 使用時の注意事項を次の表に示します。
表 7‒1

保存領域操作 API 使用時の注意事項一覧

項番

制約内容

対処方法

1

終了処理 API は、他 API を実行中の場合は実行しないでください。

他 API の処理完了を待ってから、終了処理 API を実行してください。

2

計算機の電源 OFF 操作を含めて、保存領域操作
API を使用するアプリケーションを終了する場合
は、必ず終了処理 API を実行してから終了してくだ終了処理 API を実行してから、アプリケーションを終了してください。

さい。

保存領域操作 API を使用するアプリケーションを強制終了すると保存領域が不正な状態になる場合があります。

83

8

HX-DSM との連携
この章では、HX-DSM との連携について説明します。
HX-DSM の定義方法および詳細については、HX-DSM のマニュアルを参照
してください。

85

8

HX-DSM との連携

8.1

データ用リングバッファの注意事項

データ用リングバッファの定義で、データ用リングバッファは、すべてデータ用リングバッファに書き込む
アプリケーション側が、Write 権限を持つようにしてください。
また、データ用リングバッファのブロック数には、「16384」を指定してください。

8.1.1

データ用リングバッファへの書き込み

データ用リングバッファへの書き込み時、ブロックの先頭 8 バイトには時刻を格納してください。
時刻には、マシン時刻を UTC（1970/01/01 00:00:00.000 からのミリ秒）で格納してください。
データ用リングバッファに書き込む際の構造体の例を、次に示します。
Struct Sensor{
long long _timestamp;
double sensor_a;double sensor_b;
・
・
・
}

86

// 時刻を格納する変数// データを格納する変数// データを格納する変数

8

8.2

HX-DSM との連携

トリガー用リングバッファの注意事項

エラートリガーを通知するために使用するリングバッファ（リングバッファ名称：ERR_TRIGGER）、およびイベントトリガーを通知するために使用するリングバッファ（リングバッファ名称：EVT_TRIGGER1〜
EVT_TRIGGER16）は、トリガー用リングバッファに書き込むアプリケーション側が、Write 権限を持つようにしてください。
トリガー用リングバッファの定義で、トリガーの動作状態を連携するために使用するリングバッファ（リングバッファ名称：TRIGGER_STAT）は、Widows 側が Write 権限を持つようにしてください。
また、トリガー用リングバッファのブロック数には、「4」を指定してください。

8.2.1

トリガー用リングバッファへの書き込み

ERR_TRIGGER および EVT_TRIGGER1〜EVT_TRIGGER16 への書き込み時、ブロックの先頭 8 バイ
トには時刻を格納してください。時刻には、マシン時刻を UTC（1970/01/01 00:00:00.000 からのミリ秒）で格納してください。
また、メンバには unsigned char 型の変数を一つ定義してください。
ERR_TRIGGER や EVT_TRIGGER1〜EVT_TRIGGER16 に書き込む際の構造体の例を、次に示します。
Struct ERR_TRIGGER{
long long _timestamp;
unsigned char err_trigger;}// 時刻を格納する変数// トリガーのON状態を示す変数

トリガーを動作させるには、unsigned char 型変数に 0 以外を指定してください。トリガーが停止している場合だけ、動作を開始します。すでに動作中のトリガーに対し、再度、unsigned char 型変数に 0 以外を指定しても、取得期間の延長は行いません。
トリガーの停止は、取得期間の経過か保存領域の容量が上限に達したときになります。unsigned char 型
変数に 0 を指定しても、動作中のトリガーは停止しません。
また、イベントトリガーは 16 個まで定義できますが、同時に動作するのは 8 個までとなります。上限を超えて通知された場合、EvtTrigger セクションの名称の番号順に 8 個まで動作し、9 個目以降は無視します。

8.2.2

トリガー用リングバッファからの読み込み

TRIGGER_STAT の読み込み時、ブロックの先頭 8 バイトは時刻として読み込んでください。
時刻には、マシン時刻を UTC（1970/01/01 00:00:00.000 からのミリ秒）で格納します。
また、メンバにはエラートリガーとイベントトリガー数分の unsigned char 型変数を格納します。
TRIGGER_STAT を読み込む際の構造体の例を、次に示します。
Struct TRIGGER_STAT{
long long _timestamp;// 時刻を格納する変数
unsigned char err_trigger;// エラートリガーの動作状態を示す変数
unsigned char evt_trigger1; // イベントトリガー1の動作状態を示す変数
・・・
unsigned char evt_trigger16; //イベントトリガー16の動作状態を示す変数
}

87

8

HX-DSM との連携

unsigned char 型変数が 0 以外の場合、そのトリガーが動作中であることを示しています。0 の場合、そのトリガーは停止していることを示しています。
また、イベントトリガーの動作状態を示す変数の数は、イベントトリガー定義ファイルに定義した数と同数です。
なお、NX CDMS Embedded では上記構造体を 1 秒周期で TRIGGER_STAT に書き込みます。

88

付録

89

付録 A

用語解説

付録 A

用語解説

（英字）
After 期間
トリガーが発生した時刻を基準にデータを取得し続ける期間。

Before 期間
トリガーが発生した時刻を基準に遡ってデータを取得する期間。

（あ行）
イベントログデータ
イベントトリガーによって収集するデータ。

エラーログデータ
エラートリガーによって収集するデータ。

（さ行）
サンプリング周期
データを間引く間隔。

（た行）
定常監視データ
トリガー通知に関係なく、常時収集するデータ。

トリガー
イベントトリガーとエラートリガーの総称。

（ら行）
ロググループトリガーによって収集した一定期間のデータの集まり。

90

索引
A
API の説明起動コマンド起動停止機能47‒49, 51, 53, 54

33
18

こ

D
DLL（Dynamic Link Library）

構築から運用まで 7
コマンド一覧 31
コマンド形式 33, 35, 37, 40, 42
コマンドの説明 33, 35, 37, 40, 42

81

H
HX-DSM との連携

85

さ

N
NX CDMS Embedded とは 2
NX CDMS Embedded の機能 15
NX CDMS Embedded の時刻の取り扱い 5
NX CDMS Embedded の動作定義ファイルの修正
14

R

作成環境 82
サポート機能一覧

しシステム要件 6
終了処理 API 48
障害対策フロー 10

RAS 機能 26
RAS コマンド 37

情報／状態表示機能
初期化 API 47
初期構築フロー 8W

せWindows イベントログ 75
Windows イベントログ一覧 76

前提条件

概説 1
概要 2
概略フロー

7

き
記述形式

65

6

て

い

か

33, 35, 38, 42

ソフトウェア要件

29

イベントトリガー定義ファイル 72
インクルードファイル 80
インストーラ 28
インストーラ／アンインストーラ機能
インターフェイス 47‒49, 51, 53

27

そ

あ
アンインストーラ

1628

定義記述方法 63, 65, 67, 69, 72
定義ファイル 57
定義ファイル一覧 58
定義ファイルにおける注意事項 60
定義ファイルの共通仕様 61
定義ファイルの配置場所 62
定義変更フロー 11
提供コマンド一覧 32
停止コマンド 35
定常監視データ読込 API 49
データ項目紐付け機能 23
データ項目紐付け定義ファイル 65
データ収集蓄積機能 19
データ名称定義機能 25
データ名称定義ファイル 67

91

索引

データ用リングバッファ定義ファイル 63
データ用リングバッファの注意事項 86
データ用リングバッファへの書き込み 86と動作状態表示コマンド 42
トリガー用リングバッファからの読み込み 87
トリガー用リングバッファ定義ファイル 69
トリガー用リングバッファの注意事項 87
トリガー用リングバッファへの書き込み

87

はハードウェア要件
背景 2

6

ふファイルの説明 63, 65, 67, 69, 72
ファイル名称 63, 65, 67, 69, 72

プログラムプロダクト更新フロー 12プログラムプロダクト情報表示コマンド40

ほ保存領域操作 API 45
保存領域操作 API 一覧 46
保存領域操作 API 使用時の注意事項 83
保存領域操作 API を使ったアプリケーション作成 79
保存領域操作機能 24めメッセージ一覧33, 35, 39, 40, 42

も
戻り値

33, 35, 38, 40, 42, 47, 48, 50, 52, 53, 55

よ
用語解説

90

り
リターンコード一覧

56

ろ
ロググループ削除 API 53
ロググループ容量取得 API 54
ロググループ読込 API 51

92

S-741E-00P
ソフトウェア添付資料 付録 1 マニュアル正誤表

本書に、「NX Context-based Data Management System for Embedded device ユーザーズガイド」(IoT-7-0006)の訂正
内容を記載します。

No.

対象ページ

対象箇所

誤

正

1

P.6

表 1-3

HX-DSM（型式：S-763A-96P）

RT-DSM（型式：S-763A-96P）※

項番 1
注※
NX CDMS Embedded では、RT-DSM（型式：S-763A-96P）を HX-DSM と呼称します。組込み装置に同梱のマニュアル等には、RT-DSM と記載されていますので、ご注意くださ
い。
2

3

P.48

P.76

表 4-3

E_CDMS_EMB_NOTRUNNING

(削除)

項番 2

-2

表 6-1

【説明】

【説明】

項番 3 の「内容」

警告状態から回復しました。

データが欠落した状態から回復し
ました。

4

P.78

表 6-1

【対処方法】

項番 11 の「内容」

value の値は、「4.8【対処方法】

リター

value の値は、
「4.8

リターンコ

ンコード一覧」を参照して対ード一覧」を参照して対処してく処してください。

ださい。なお、本メッセージは初期化 API を一度も実行していない
場合、出力されません。

5

P.86

8.1.1 データ用リング
バッファへの書き込み―

データの書き込みを行わないリン
グバッファを、データ用リングバ
ッファ定義ファイルに定義しないでください。データの書き込みが行われないデータ用リングバッフ
ァが存在する場合、組込み CDMS の処理が遅延し、全データが欠損となる恐れがあります。

- 1/1 -