DocuWorks 9/DocuWorks 9.1でのDocuWorks Development Toolkitのご利用について

登録日:2018年1月17日
最終更新日:2022年9月22日
コンテンツID:003

DocuWorks 9 / DocuWorks 9.1でのDocuWorks Development Tool Kit(SDK)の利用について記載します。

  • 注記1.~5.の記載で、DocuWorks 9としている部分はDocuWorks 9.1でも同様です。
  • DocuWorks 9では、インターフェイス(API/SPI)の上位互換性があります。DocuWorks Development Tool Kit 8までで作成したアプリケーションからの利用につきましては、DocuWorks 9との組み合わせでも原則動作します。
    • 以下の場合には、別途ライセンス商品をご購入いただく必要がございます。
  • DocuWorks 9上で、DocuWorks Development Tool Kit 9を用いて新規に開発したアプリケーションを利用する場合は、以下が必要になります。
    • ご利用のDocuWorks 9のバージョンを9.0.1以降にアップデートしてください。
    • 以下の場合には、別途ライセンス商品をご購入いただく必要がございます。

DocuWorks 9の環境でDocuWorks APIを利用する場合は、以下に示すようにAPIの一部機能が制限されます。

アプリケーション種別 DocuWorks 8以前との組み合わせ DocuWorks 9との組み合わせ
制限事項 制限を解除する方法
デスクトップアプリケーション 制限なし
  • OCRを呼び出す機能が利用できません注1
デスクトップアプリケーション向けライセンス商品「DocuWorks OCR License for Development Tool Kit(デスクトップアプリケーション用)」をご購入・設置していただく必要があります
サーバーアプリケーション4参照 制限なし
  • OCRを呼び出す機能が利用できません注1
  • PDFをDocuWorks文書に変換する機能についてはライセンス上制限されます注1
サーバーアプリケーション向けライセンス商品「DocuWorks OCR/PDF License for Development Tool Kit(サーバーアプリケーション用)」をご購入・設置していただく必要があります
  • 注1制限事項の具体的な機能については、「5-1. DocuWorks 8以前で利用していた処理が、DocuWorks 9上では別途ライセンスが必要となる機能」をご確認ください。

DocuWorks サブスクリプション/サブスクリプション Suiteに関する制限事項

DocuWorks API(XDWAPI)で作成したプログラムを使用する場合、ボリュームライセンス版またはライセンス認証版のDocuWorksをインストールした環境でご利用ください。
DocuWorks サブスクリプションでは、定期的なログインが必要です。バッチ処理などによりXDWAPIを連続して実行中に再ログインが必要になると処理が停止されるため、推奨できません。

サーバーアプリケーションの定義

  • ネットワーク内にあるコンピュータ上にインストールされた状態で、個人のユーザーによってなされるのではない処理(例えば、他のアプリケーションによる自動処理)をするアプリケーション。
  • アプリケーションが設置されるOSがクライアントOSか、サーバーOSかは関係ありません。

サーバーアプリケーションでの利用の例

  • 別のクライアントからの要求に応じて、サーバー上にあるDocuWorks Development Tool KitのOCR/PDFを使ったアプリケーションが実行された場合
  • サービスで自動起動し、DocuWorks Development Tool KitからOCR/PDFを利用する場合

サーバーアプリケーションに該当しない(デスクトップアプリケーション)利用の例

  • リモートデスクトップでクライアントからサーバーへ接続し、アプリケーションを利用する場合
  • ファイルサーバー上のDocuWorksファイルにアプリケーションでOCR処理を実行し、別の人がそのファイルを参照する場合
  • ファイルサーバー上のDocuWorksファイルに個人PCのアプリケーションからOCR処理を実行する場合

5-1. DocuWorks 8以前で利用していた処理が、DocuWorks 9上では別途ライセンスが必要となる機能

該当するアプリケーション種別 該当機能 該当関数 DocuWorks 9上で動作させた結果
デスクトップアプリケーション サーバーアプリケーション
該当する 該当する OCR機能
  • XDW_ApplyOcr
内蔵エンジン(XDW_OCR_ENGINE_DEFAULT/XDW_OCR_ENGINE_FRE)を指定すると、XDW_E_ACCESSDENIEDエラーになります。

(ライセンス不要)
該当する PDF文書をXDW変換する機能
  • XDW_BeginCreationFromAppFile
  • XDW_BeginCreationFromAppFileW
  • 注記XDW_BEGIN_CREATE_OPTIONオプションのbNoUseSpecifiedApp = TRUEの場合
ライセンス適用有無による動作の違いはありません。

5-2. DocuWorks 8以前で利用していた処理が、DocuWorks 9上では利用できなくなる機能

該当するアプリケーション種別 該当機能 該当関数 DocuWorks 9上で動作させた結果
デスクトップアプリケーション サーバーアプリケーション
該当する 該当する 自己解凍文書作成機能
  • XDW_CreateSfxDocument
  • XDW_CreateSfxDocumentW
常にXDW_E_NOT_INSTALLEDエラーになります。
該当する 該当する テキスト矩形情報取得機能
  • 注記OCR処理した文書に対して利用する場合のみ
  • XDW_FindTextInPage
  • XDW_GetRectInFoundObject
DocuWorks 9でOCRした文書を、DocuWorks 8の環境でXDW_FindTextInPageすると、XDW_E_ACCESSDENIEDエラーになります。

5-3. DocuWorks 8以前で利用していた処理が、DocuWorks 9上では処理結果が異なる機能

該当するアプリケーション種別 該当機能 該当関数 DocuWorks 9上で動作させた結果
デスクトップアプリケーション サーバーアプリケーション
該当する 該当する OCR機能
  • XDW_ApplyOcr
OCRエンジンの違いにより結果が異なります。
該当する 該当する PDF文書をXDW変換する機能
  • XDW_BeginCreationFromAppFile
  • XDW_BeginCreationFromAppFileW
  • 注記XDW_BEGIN_CREATE_OPTIONオプションのbNoUseSpecifiedApp = TRUEの場合
変換エンジンの違いにより結果が異なります。
該当する 該当する ページ回転する機能
  • XDW_RotatePage
  • XDW_RotatePageAuto
アノテーションが貼ってあるページに対して実行すると、DocuWorks 8ではXDW_E_INVALID_OPERATIONエラーになりますが、DocuWorks 9では成功します。(DocuWorks Viewerでも回転できるアノテーションの場合)

6-1. DocuWorks 9以前で利用していた処理が、DocuWorks 9.1上では処理結果が異なる機能

該当するアプリケーション種別 該当機能 該当関数 DocuWorks 9.1上で動作させた結果
デスクトップアプリケーション サーバーアプリケーション
該当する 該当する イメージファイルからXDW変換する機能
  • XDW_CreateXdwFromImageFile
  • XDW_CreateXdwFromImageFileW
  • XDW_CreateXdwFromImageFileAndInsertDocument
  • XDW_CreateXdwFromImageFileAndInsertDocumentW
XDW変換時の画像圧縮オプションにMRC圧縮(XDW_COMPRESS_MRC_NORMAL / XDW_COMPRESS_MRC_HIGHQUALITY / XDW_COMPRESS_MRC_HIGHCOMPRESS)が指定された場合でも、JPEG圧縮(XDW_COMPRESS_NORMAL / XDW_COMPRESS_HIGHQUALITY / XDW_COMPRESS_HIGHCOMPRESS)が指定された場合と同じ結果となります。
該当する 該当する XDW文書からPDF変換する機能
  • XDW_ConvertPageToImageFile
  • XDW_ConvertPageToImageFileW
PDF変換時の画像圧縮オプションにMRC圧縮(XDW_COMPRESS_MRC_NORMAL / XDW_COMPRESS_MRC_HIGHQUALITY / XDW_COMPRESS_MRC_HIGHCOMPRESS)が指定された場合でも、JPEG圧縮(XDW_COMPRESS_NORMAL / XDW_COMPRESS_HIGHQUALITY / XDW_COMPRESS_HIGHCOMPRESS)が指定された場合と同じ結果となります。
該当する 該当する XDW文書からPDF文書を取り出す機能
  • XDW_GetCompressedPageImage
  • XDW_GetCompressedPageImageW
高圧縮XDWからのイメージ取り出しの場合でも、JPEG圧縮のPDF文書として取り出されます。
該当する 該当する XDW文書内の文書属性やアノテーションをXMLファイルに入出力する機能
  • XDW_GetXmlFile
  • XDW_SetXmlFile
入出力可能なXMLファイルの名前空間が
xmlns:dw="http://www.fujifilm.com/fb/2021/04/docuworks/api/docuworksfile"に変更されました。