uCosminexus DocumentBrokerでは、Webアプリケーションを開発するためのAPI(Java™インタフェース)を提供。業務の要件や処理の流れに応じてオリジナルのユーザーアプリケーションを開発・構築することができます。業務固有の分類の追加、文書から文書へのリンクの設定、既存の業務システムとの連携など、さまざまな機能要件の実現が可能です。開発したアプリケーションは、高信頼のWebアプリケーションサーバ「uCosminexus Application Server」上で稼動させることができます。

アプリケーション画面例
開発用APIはJava™のライブラリとして別システムに組み込むことができるので、基盤フレームワークが持つ「文書登録」や「文書検索」といった機能を別システムから利用することができます。uCosminexus DocumentBrokerを「文書の保管庫」と位置づけることにより、各システム間で文書を共有することが可能になります。
開発用のAPIのうち、代表的なものをご紹介します。
基盤フレームワークのAPIを実行するにはログインが必要です。ログイン中はユーザにセッションが割り当てられ、ユーザに応じた安全なアクセス制御が行なわれます。
| API名 | 機能概要 |
|---|---|
| login | ログイン |
| logout | ログアウト |
| getLoginUserInfo | ユーザ情報の取得 |
| checkSession | セッションが有効かのチェック |
基盤フレームワークでは、トランザクションの概念を取り入れています。トランザクションの機能により、連続する複数のAPI操作に対して、データベースのように一貫性をもって実行することができます。
| API名 | 機能概要 |
|---|---|
| begin | トランザクションの開始 |
| commit | トランザクションの確定 |
| rollback | トランザクションの取り消し |
文書やフォルダはAPIで作成/削除できます。開発アプリケーションの多様性を広げるため、「版(バージョン)管理しない文書」や「文書を持たない独立データ」といったオブジェクトも作成できるようになっています。
| API名 | 機能概要 |
|---|---|
| createVrDocument | 文書の作成 |
| createFolder | フォルダの作成 |
| createDocument | 版(バージョン)無し文書の作成 |
| createIndependentData | 独立データオブジェクトの作成 |
| removeObject | 各種オブジェクトの削除 |
| removeObjects | 複数オブジェクトの一括削除 |
文書は、実体である文書ファイルと付加情報である文書属性を持ちます。それぞれ独立して取り扱うことができます。また、文書に対してデータベースのようにreadロック/writeロックを設定することもできます。
| API名 | 機能概要 |
|---|---|
| readProperties | 文書属性の読み出し |
| writeProperties | 文書属性の書き込み |
| downloadContents | 文書ファイルの取り出し |
| uploadContents | 文書ファイルの書き込み |
| lock | トランザクション内で有効なロック設定 |
検索機能では、文書やフォルダ等各種オブジェクトを検索できます。検索条件には文書名や属性情報を指定できます。また、文書に対しては全文検索も行なえます。検索条件はSQLライクな構文を用いて指定できます。
| API名 | 機能概要 |
|---|---|
| executeSearch | 検索の実行 |
| getRowCount | 検索結果のデータ数の取得 |
| first | 検索結果リストの先頭データの参照 |
| next | 検索結果リストの次データの参照 |
文書に対しては版(バージョン)管理を行なうことが出来ます。チェックアウト操作で更新準備をしたのち、チェックイン操作を行なうことで、文書の過去版が自動で作成されます。
| API名 | 機能概要 |
|---|---|
| checkOut | 文書のチェックアウト |
| checkIn | 文書のチェックイン |
| cancelCheckOut | 文書のチェックアウトの取り消し |
| getCheckOutStatus | 文書のチェックアウト状態の確認 |
| getCheckOutUserId | 文書をチェックアウトしたユーザの取得 |
| getVersionObjList | 文書の版(バージョン)一覧の取得 |
| deleteVersion | 文書の特定バージョンの削除 |
リンクとはオブジェクト同士の“つながり”です。フォルダツリーでの「フォルダ−文書」「上位フォルダ−下位フォルダ」の関係もリンクで表現します。ほかに「文書−文書」にもリンクをはることができます。
| API名 | 機能概要 |
|---|---|
| link | オブジェクト間にリンクを設定 |
| unlink | リンクの解除 |
| getChildList | フォルダの下位オブジェクト一覧の取得 |
| getDCRParent | 上位フォルダの取得 |
| move | 文書・フォルダの移動 |
レンディションとは、文書ファイルの形式(拡張子)のことです。基盤フレームワークでは、一つの文書の中にレンディションの異なる文書ファイルを複数登録することができます。(例:AAA.docとAAA.pdfを一つの文書として登録)
| API名 | 機能概要 |
|---|---|
| addRendition | 文書にレンディションを追加 |
| getRenditionList | 文書のレンディション一覧の取得 |
| deleteRendition | 文書から特定レンディションを削除 |