外部システムとの連携について · option 外部連携apiセットでできること...

Copyright © 2015 CIMTOPS CORPORATION - All Rights Reserved.

ConMas i-Reporter外部システムとの連携について

2015.02

Copyright © 2015 CIMTOPS CORPORATION - All Rights Reserved. 2

本書の説明

• 本書は、ConMas i-Reporterの外部システムとの連携について、• 標準パッケージの機能で可能なことと• オプション機能：外部連携APIセットで可能なこと

• について、概要をまとめたものです。


外部システムとのインターフェース概要図

標準機能範囲

オプション機能範囲

外部システム

外部システム

データ

外部システム

データ

外部システム

データ

ConMas Server

ASP.NET

Web

Application

ConMas Manager

Web Browser 帳票トップ定義ビュー

シート定義ビュー

クラスタ定義ビュー

定義権限ビュー

定義クラスター権限ビュー

定義参考資料ビュー

定義ラベルマスタービュー

定義ラベルビュー

帳票ラベル定義ビュー

帳票トップビュー

シートビュー

クラスタービュー

帳票権限ビュー

帳票クラスター権限ビュー

帳票参考資料ビュー

帳票ラベルマスター

ユーザーマスタービュー

グループマスタービュー

グループ所属マスタービュー

端末マスタービュー

システム設定ビュー

カスタムマスタービュー

ConMas Generator

Windows Service

Application

定義情報参照ビュー

帳票情報参照ビュー

マスター情報参照ビュー

ジョブ設定

入力フォルダー設定

出力フォルダー設定

ログ出力設定

ジョブスケジュール実行

設定・管理機能

管理・閲覧・編集・承認

帳票データー出力

自動帳票作成

各種マスター取り込み

監視・ジョブ実行

フォルダー監視実行

CSV CSV

外部Application

実行

外部取り込み

アプリケーション

外部取り込み


外部取り込み


postgreSQL ClientFile System

【 Web API 連携】

「ConMas Web Server」が提供するREST形式のWebAPIを

利用して、データの取得、登録が可能です。

ログインからセッションを保持した連続した操作が可能です。

＜呼び出し例＞

RESTコマンド（ログイン）

↓（POST）

RESTコマンド（帳票取得）

↓（POST）

RESTコマンド（帳票登録）

↓（POST）

RESTコマンド（ログアウト）

ブラウザを始め、WebClient機能を実装できるコマンドリ

ファレンス及び、.NET(C#)サンプルコードをご提供します。

【データー参照ビュー】

「ConMas i-Reporter」のデータベース

から「postgreSQL」に直接接続し、

「参照ビュー」からデータを取得できます。

「postgreSQL」のクライアントミドル

ウェア等の接続モジュールやドライバーが

必要となります。

【フォルダ監視・ジョブスケジュール】

「ConMas Generator」により、

フォルダ監視によるデータのインポート、及び、定期ジョ

ブ実行によるi-Reporterデータのエクスポートが可能です。

ConMas Generatorの入出力形式は、システム標準形式と

なるため、個別の外部プログラムにより、データ変換が必

要となります。

コマンドライン形式による外部プログラム実行が可能です。

ConMas Generator から変換プログラムを呼び出すことが

可能です。

File System

外部システム

データ

ConMas Web API

ログイン

ログアウト

Web API

定義一覧取得

定義簡易詳細情報取得

定義ロック取得／解除

定義権限情報取得／設定

定義ラベル情報取得／設定

帳票一覧取得

帳票簡易詳細情報取得

帳票ロック取得／解除

帳票権限情報取得／設定

帳票ラベル情報取得／設定

自動帳票作成

帳票更新

帳票削除

帳票ダウンロード

ユーザー情報取得

ユーザー情報登録

グループ情報取得

グループ情報更新

端末取得

URLスキーム取得

HTTP/HTTPS( REST )

PostgreSQL 9.1Data Base

ASP.NET Web Application

外部Application

実行

外部取り込み


Web Client

インポートエクスポート

CSV

※標準機能 ※標準機能

※標準機能

CSV

サーバー内の

指定ディレクトリへの

CSV,XMLファイル出力

帳票画像、帳票PDFの出力

※オプション機能



選択値情報更新

定義削除

CSVHTTP/HTTPS

( REST )


• 標準機能では主に、ユーザー操作による手動取り込み、標準出力ファイルの参照、データベース接続によるビュー参照が可能です。

• 外部システム ⇒ i-Reporter• ConMas Manager(Web管理画面）のシステムメニューから

手動実行にてi-Reporterへデーターを取り込むことができます。

• 自動帳票作成

• 外部システムから出力されたCSVもしくはXMLデータの「i-Reporter標準レイアウト形式ファイル」を取り込んで複数枚の帳票を自動生成します。

• 選択候補値の取り込み

• 外部システムから出力されたCSVもしくはXMLデータの「i-Reporter標準レイアウト形式ファイル」を取り込んで指定した帳票定義の選択クラスターの候補値を更新します。

• マスターの取り込み

• 外部システムから出力されたCSVもしくはXMLデータの「i-Reporter標準レイアウト形式ファイル」を取り込んで、i-Reporterのマスターの値を更新します。

標準パッケージの機能でできること


標準パッケージの機能でできること• i-Reporter ⇒ 外部システム

• 指定ディレクトリへの帳票データの自動出力• 帳票が完了処理されると指定ディレクトリへ以下を自動出力します。

• 帳票に入力されたCSVデーター• 帳票に入力されたXMLデーター• 帳票の画像（PNG)• 帳票のPDF• 帳票のExcel（Excelファイルから帳票定義を作成したもののみ）

• お客様サイドにて指定ディレクトリーの監視型プログラムを開発することにより帳票データーを自動に取得し外部システムへ連携することができます。

• 帳票データCSV一括出力• ConMas Manager(管理画面)から複数の帳票データをＣＳＶ形式で一括出力す

ることが可能です。• 同一定義から作成された複数の帳票データが１行１帳票のＣＳＶファイルに出力され

ます。• 画像、ＰＤＦファイルを同時に出力することも可能です。（ZIP圧縮形式）

• 外部システム参照用ビューの公開• i-ReporterのデータベースPostgreSQLに直接接続し、参照用のビューから各種帳

票データを取得できます。postgreSQLに接続できる環境が必要となります。参照のみとなりますので、追加、変更、削除はできません。

• 定義情報参照ビュー• 帳票情報参照ビュー• マスター情報参照ビュー


完了した帳票のデーター自動出力概念図

• 完了時の指定ディレクトリへの帳票データの自動出力– 帳票が完了処理されると指定ディレクトリへひとつの帳票に対して以下のセットを自動出力します。

– 出力するファイルは帳票定義単位に指定可能です。

• 帳票に入力されたCSVデーター

• 帳票に入力されたXMLデーター

• 帳票の画像PNG

• 帳票のPDF

• 帳票のExcel（Excelファイルから帳票定義を作成したもののみ）

– サーバーの指定ディレクトリーの監視型プログラムを開発することにより帳票データーを自動に取得し外部システムへ連携することができます。

サーバー内の指定ディレクトリへのCSVファイル出力XMLファイル出力帳票画像PNG出力帳票PDFの出力帳票Excelの出力

CSV

指定ディレクトリーの監視型プログラム


外部参照ビューの公開概念図

• 外部システムからConMasDBの全ての情報を取得可能な参照ビューが公開されています。– ConMasデータベースPostgreSQLに直接接続し、参照用のビューからすべて

の帳票定義情報、帳票情報、マスター情報を取得できます。

– postgreSQL DBに接続できる環境が必要となります。

– 参照のみで、ConMasDBの情報の追加、変更、削除はできません。

• 参照ビュー– 帳票定義情報参照ビュー

– 帳票情報参照ビュー

– マスター情報参照ビュー

帳票トップ定義ビューシート定義ビュークラスタ定義ビュー定義権限ビュー定義クラスター権限ビュー定義参考資料ビュー定義ラベルマスタービュー定義ラベルビュー帳票ラベル定義ビュー

定義情報参照ビュー

帳票トップビューシートビュークラスタービュー帳票権限ビュー帳票クラスター権限ビュー帳票参考資料ビュー帳票ラベルマスター帳票ラベルビュー

帳票情報参照ビュー

ユーザーマスタービューグループマスタービューグループ所属マスタービュー端末マスタービューシステム設定ビューカスタムマスタービュー

マスター情報参照ビュー


Option 外部連携APIセットでできること

• オプションの外部連携APIセットには、以下の二つが用意されています。これを利用して、外部システムにおいてプログラムを開発することによりConMas i-Reporterとの各種の自動処理のしくみを容易に構築することが可能です。連携の方法は以下の２つがあります。

• ①Web API 連携ConMas Web API• 外部システムのプログラムからのAPI呼び出しのリアルタイム連携

• ②Windows Service Application連携ConMas Generator• 外部システムからのファイル出力によるフォルダ監視＋ジョブスケジュールによる連携



•①ConMas Web API WebAPI連携

• 外部アプリケーションからi-Reporterを直接操作するためのAPIセットです。

• 「ConMas Web Service」のAPI呼び出し用URLに必要なパラメーター付加して呼び出すことで、データの取り込み、抽出などが可能です。

• Webクライアントととして動作できるアプリケーション、または、ブラウザーから利用できます。

• 本APIにて取り込み、出力するCSV、XMLファイルのレイアウトは、i-Reporter標準レイアウト形式、画像形式はPNG形式となります。

• ConMas Web Serverが提供するREST形式の各種WebAPIを利用して、外部システムからデータの取得、登録、更新が可能です。

• ログインからセッションを保持した連続した操作が可能です。• ブラウザを始め、WebClient機能を実装できるコマンドリファレンス、

及び、.NET(C#)サンプルコードが添付されます。



• 提供されるWeb API一覧

• 共通• ログイン• ログアウト

• 帳票一括操作• 自動帳票作成• 帳票更新• 帳票ダウンロード• 帳票削除

• 定義一括操作• 選択値情報更新• 定義削除




• 定義操作• 定義一覧取得• 定義簡易詳細情報取得• 定義ロック取得• 定義ロック解除• 定義権限取得• 定義権限設定• 定義ラベル取得• 定義ラベル更新• 帳票ラベル定義取得• 帳票ラベル定義更新




• 帳票操作• 帳票一覧取得• 帳票簡易詳細情報取得• 帳票ロック取得• 帳票ロック解除• 帳票権限取得• 帳票権限設定• 帳票ラベル取得• 帳票ラベル更新




• システムメンテナンス• グループ情報取得• グループ情報更新• ユーザー情報取得• ユーザー情報登録• グループ所属取得• グループ所属更新• 定義ラベルマスタ取得• 定義ラベルマスタ登録• 帳票ラベルマスタ取得• 帳票ラベルマスタ登録• 参考資料情報取得• 参考資料情報更新• 端末情報取得• URLスキーム取得



•②Windows Service Application連携

• 指定フォルダ監視• フォルダに出力されたファイルを自動でi-Reporterに取り込みます。

• スケジュール実行• 時間指定で外部システムから出力されたi-Reporter標準レイアウト

形式のファイルを自動でi-Reporterに取り込みます。• 時間指定でi-Reporterからi-Reporter標準レイアウト形式の

ファイルを出力することが可能です。• 取り込み処理、出力処理実行時に、外部アプリケーションを呼び出すことが

可能です（コマンドライン形式による外部プログラム実行）。• ConMas Generatorの入出力形式は、i-Reporterのシステム標準形式

となるため、個別の外部プログラムにより、データ変換が必要となります。


Web API 連携概念図

• 『ConMas Web API』を使用すれば、外部システムのプログラムから各種APIを呼び出しConMasDBの全ての情報にリアルタイムにアクセスすることができます。

– REST形式のWebAPIを利用して、データの取得、登録が可能です。

– ログインからセッションを保持した連続した操作が可能です。

ConMas Web API


外部システムデータ

外部取り込みアプリケーション

Web Client

＜呼び出し例＞

RESTコマンド（ログイン）

↓（POST）

RESTコマンド（帳票取得）

↓（POST）

RESTコマンド（帳票登録）

↓（POST）

RESTコマンド（ログアウト）

ブラウザを始め、WebClient機能を実装でき

るコマンドリファレンス及び、.NET(C#)サンプ

ルコードをご提供。

ログインログアウト

Web API一覧

定義一覧取得定義取得／登録／削除定義ロック取得／解除権限情報取得／設定ラベル情報取得／設定参考資料取得／設定

新規帳票取得帳票一覧取得帳票取得／登録／削除帳票ロック取得／解除権限情報取得／設定ラベル情報取得／設定参考資料取得／設定

自動帳票作成選択値情報更新帳票削除定義削除帳票一括ダウンロード

ユーザー情報取得ユーザー情報登録グループ情報取得グループ情報更新共通情報取得共通情報更新端末取得

ConMas DB


Windows Service Application連携概念図

CSV

• 『ConMas Web API』を使用すれば、外部システムのプログラムからのファイル出力によるフォルダ監視＋ジョブスケジュールによる連携によりConMasDBの全ての情報に自動連携することができます。

– 取込処理、出力処理実行時に、外部アプリケーションを呼び出すことが可能です（コマンドライン形式による外部プログラム実行）。

ConMas Web API


ConMas DB

ConMas Generator

Windows Service Application

ジョブ設定入力フォルダー設定出力フォルダー設定ログ出力設定

ジョブスケジュール実行

監視・ジョブ実行

フォルダー監視実行外部Application

実行

外部Application

実行

HTTP/HTTPS( REST )

インポートエクスポート

CSV





File System File System

【フォルダ監視・ジョブスケジュール】

フォルダ監視によるデータのインポート、及び、定

期ジョブ実行によるi-Reporterデータのエクス

ポートが可能です。

ConMas Generatorの入出力形式は、システ

ム標準形式となるため、個別の外部プログラムに

より、データ変換が必要となります。

コマンドライン形式による外部プログラム実行が可

能です。

ConMas Generator から変換プログラムを呼

び出すことが可能です。


データーを差し込んだ帳票の自動発行概念図

オーダ―No.製造No.Lot No.機械 No.

ABC12345

XYZ000121234

LOT2011121213

MAC2101

検査記録

測定X測定Y測定Z品質判定記録者

帳票定義ID：ABC0001オーダ―No. ABC12345製造No. XYZ000121234Lot No. LOT2011121213機械 No. MAC2101

入力前帳票×100枚

• 日々必要となる大量の入力帳票の作成を自動化します。帳票作成の負担を現場にかけません。– 外部システムから出力し作成した情報を、外部連携APIセットを使用して帳票

内の複数の特定のクラスターに差し込み帳票を自動作成します。

帳票定義ID:ABC0001検査記録に対する100件のオーダーNO.,製造NO.,LotNO,機械NO.の情報を作成します。

帳票定義ID:ABC0001 検査記録に対して100件分のデータを各帳票の指定場所に差し込みした検査記録帳票(入力前)を100枚自動作成します。

ABC12345

LOT21213

MAC2101

検査記録


オーダ―No.製造No.Lot No.機械 No

XYZ01234

帳票定義ID：ABC000用のデータ×100件

上位システム

ConMas DB

iPadアプリで入力

CSV

ConMas Web API


オーダ―No.製造No.Lot No.機械 No.

検査記録


帳票定義ID：ABC0001

上位システムから自動設定される入力項目。

作業者が現場で入力する項目。


選択候補値の自動反映概念図

• 選択クラスターの選択候補値を上位システムのマスターから自動アップデートすることができます。– 外部システムから出力し作成した情報を、外部連携APIセットを使用して複数

の帳票定義の各選択クラスターの選択候補値のデーターをまとめて自動アップデートすることが可能です。

＜iPadアプリでの帳票入力＞帳票定義ID：ABC0001検査記録クラスターNO.21生出筒井伊賀上松尾土井帳票定義ID：CBD0005品質記録クラスターNO.30生出筒井伊賀上

帳票定義ID:ABC0001検査記録のクラスターNO.21：単一選択クラスター帳票定義ID:CBD0005品質記録のクラスターNO.30：単一選択クラスター・・・・・・の選択候補値情報を作成します。

帳票定義の各選択クラスターの選択候補値情報

上位システム

CSV

ConMas DB

帳票定義ID:ABC0001検査記録のクラスターNO.21：単一選択クラスターの選択候補値がアップデートされる。

ConMas Web API


外部システムとの連携について · option 外部連携apiセットでできること...

Documents