> For the complete documentation index, see [llms.txt](https://manuals.i-reporter.jp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manuals.i-reporter.jp/output-the-data/data-output/docushare-docuworks.md).

# DocuWorks出力機能 / DocuShare連携機能

## **DocuWorks文書生成・DocuShare(ApeosWare Flow Management)連携概要**

自動ファイル出力で出力されたPDFファイルをDocuWorks文書ファイルに変換し、自動で出力します。

DocuWorks文書の生成は専用プログラムによりバックグラウンド（非同期）で行われます。

{% hint style="warning" %}
本機能の利用には 「DocuWorks 9.1」 もしくは 「DocuWorks 10」 のインストールが必要です。
{% endhint %}

DocuShare連携設定をすることにより連携に必要なCSVファイル出力、連携出力先の共有フォルダーへのファイルコピーを行い、ApeosWare Flow Managementを介してDocuShareに連携することが可能です。

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/Kzprr2p6PdnhBxfABUYY/image.png" alt=""><figcaption></figcaption></figure></div>

## **DocuWorks出力**

### **フォルダー構成**

`[ドライブ]:\ConMas\SettingFiles\xml\`\
配下は以下の構成となっています。

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/kjIhuL8FH543JgHwWPLM/image.png" alt=""><figcaption></figcaption></figure></div>

{% hint style="warning" %}
上記フォルダは必ず必要です。
{% endhint %}

{% hint style="danger" %}
i-ReporterのDocuWorks出力機能が稼働しているサーバーには、DocuWorksプリンタを使用する他のアプリケーション/システムやWindowsの通常使うプリンタを使用して印刷を行うアプリケーション/システムを設置しないでください。

アプリケーション/システム間の競合によって、DocuWorks出力機能、および、他のアプリケーション/システムが誤動作を起こす恐れがあります。
{% endhint %}

### **i-Repo Managerでの設定**

帳票の自動出力設定を行います。\
必ず、i-Repo Managerの「システム管理」 ＞ 「共通マスター管理」の設定にて、帳票保存時の自動出力設定がされている必要があります。

* 共通キー　　　“OUTPUT\_SETTING”
* 共通項目名称　“PDF”、“XDW”、“XDW\_MANUAL\_OUTPUT”
  * **PDF**\
    自動出力でPDFファイルを出力します。\
    ※DocuWorks文書の元となるPDF文書を必ず出力しておく必要があります。
  * **XDW**\
    自動出力でDocuWorks文書ファイルを出力します。
  * **XDW\_MANUAL\_OUTPUT**\
    i-Repo Managerの帳票詳細画面でDocuWorks文書をダウンロード可能にします。
* 共通項目値　　“true”：出力する、“false”：出力しない

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/A9naVOXVpkJhwzbObsgT/image.png" alt=""><figcaption></figcaption></figure></div>

{% hint style="success" %}
ファイル名、出力フォルダ等のその他出力設定は通常の自動ファイル出力設定に依存します。
{% endhint %}

{% hint style="warning" %}
設定前に登録された帳票には、DocuWorksのダウンロードボタンは表示されません。\
再度、帳票をi-Repo i-Reporterより登録し直すことで対応可能となります。
{% endhint %}

### **DocuWorks文書生成プログラム**

プログラムは以下のフォルダーに格納されています。

`[ドライブ]:\ConMas\SettingFiles\xml\interface\report\DW\ConMasCreateDW`

{% hint style="success" %}
文書プログラムは多重実行せず、指示された変換を順番に漏れなく実行します。
{% endhint %}

　

「ConMasCreateDW\.exe.config」を環境に合わせて設定します。

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/KwgDeCGMfvkwZBEHbnRe/image.png" alt=""><figcaption></figcaption></figure></div>

DocuWorks生成プログラム設定ファイル（ConMasCreateDW\.exe.config）

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/z2aTParCvSBnizAeNE8V/image.png" alt=""><figcaption></figcaption></figure></div>

* ClientSettings\
  配置したinterfaceフォルダ内の\report\DWフォルダを指定します。
* MaxFailures\
  リトライ回数です。指定回数失敗するとpoolからfailureに移動します。（既定値は３回です）
* CreationTimeout\
  生成が完了するまでの監視タイムリミット（秒）です。（既定値は６０秒です）

{% hint style="success" %}
リトライ回数、タイムアウト値はネットワーク環境、変換対象のファイルサイズに合わせて必要に応じた調整を行ってください。
{% endhint %}

### **手動実行と確認**

設定が完了したら、まずは手動でプログラムを実行し、正しくXDWファイルが作成されることを確認します。

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/tyO6F8jvn5oycext50Q3/image.png" alt=""><figcaption></figcaption></figure></div>

【手順】

1. 帳票を保存し、自動出力ファイル機能により、変換対象のPDFファイルが自動出力されていることを確認します。\
   同時に、poolフォルダにxdw変換指示ファイルが作成されていることを確認します。
2. ConMasCreateDWフォルダ内のConMasCreateDW\.exeを実行します。\
   処理が成功するとxdwファイルが生成され、xdw変換指示ファイルはsuccessフォルダに移動します。

{% hint style="success" %}

* xdwファイルはPDFと同一フォルダ、同一ファイル名で生成されます
* 失敗した場合、リトライ回数に達するまで指示ファイルはpoolフォルダに残り、次回実行時に再度変換処理の対象となります。
* 失敗がリトライ回数に達するとfailureフォルダに移動します。\
  失敗原因が解消（タイムアウト値の延長など）し、再度変換処理の対象にしたい場合は、failureフォルダーからpoolフォルダに手動でファイルを移動することで再度変換処理の対象にすることが可能です。
  {% endhint %}

### **手動ダウンロード**

DocuWorks文書出力済みの入力帳票は、i-Repo ManagerよりDocuWorks文書を手動でダウンロード可能です。

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/hlQM2PjL9cbSgwxgdyF5/image.png" alt=""><figcaption></figcaption></figure></div>

{% hint style="warning" %}
上記画面表示時に対象のxdwファイルが未生成の時はDWダウンロードボタンが表示されません。

また、何らかの理由で対象のxdwファイルがサーバーから削除された場合はダウンロードできません。
{% endhint %}

### **自動実行**

WindowsタスクスケジューラーにConMasCreateDW\.exeの定期実行を登録することで、定期的にDocuWorks文書を自動生成することが可能です。

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/DYiwGk4rrMswHwXOJZvw/image.png" alt="" width="563"><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/Z9iBBnCanyqSatDlrTeM/image.png" alt="" width="402"><figcaption></figcaption></figure></div>

{% hint style="success" %}

* より短い間隔で定期実行するとリアルタイムに近い間隔で変換が実行されます。
* プログラムは多重起動せず、起動際にpoolフォルダに存在したxdw変換指示ファイルを全て処理します。
* Windowsタスクスケジューラーの基本的な設定方法は以下をご参照ください。\
  \[タスク スケジューラを起動する]\
  <https://technet.microsoft.com/ja-jp/library/cc721931.aspx>\
  \[タスク スケジューラの操作方法]\
  <https://technet.microsoft.com/ja-jp/library/cc766428.aspx>
  {% endhint %}

## **DocuShare連携**

### **システム設定**

帳票の自動出力設定を行います。\
必ず、i-Repo Managerの「システム管理」 ＞ 「共通マスター管理」の設定にて、帳票保存時の自動出力設定がされている必要があります。

* 共通キー　　　“OUTPUT\_SETTING”
* 共通項目名称　“DATA\_OUTPUT”、“PDF”、“EXCEL”、“XDW”、“EDIT”、“FINISH”
  * **DATA\_OUTPUT**\
    DocuShare連携フォーマットCSVを出力します。
  * **PDF**\
    PDFファイルを出力します。
  * **EXCEL**\
    EXCELファイルを出力します。
  * **XDW**\
    自動出力でDocuWorks文書ファイルを出力します。
  * **EDIT**\
    編集保存時に各ファイルを出力します。
  * **FINISH**\
    完了保存時に各ファイルを出力します。
* 共通項目値　　“true”：出力する、“false”：出力しない

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/6fsHu0e9R7J4Uz93o5p4/image.png" alt=""><figcaption></figcaption></figure></div>

{% hint style="success" %}
DocuShare連携処理後も、自動出力されたファイルはBASE\_FOLDER指定のフォルダ内に残ります。
{% endhint %}

### **連携設定画面の表示**

DocuShareへの連携設定は、i-Repo Managerの「データー出力」 ＞ 「出力項目の選択」画面にて行います。

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/0nfNpoSAKH68kV3EyVkW/image.png" alt=""><figcaption></figcaption></figure></div>

### **連携設定**

帳票の自動出力設定を行います。\
必ず、i-Repo Managerの「システム管理」 ＞ 「共通マスター管理」の設定にて、帳票保存時の自動出力設定がされている必要があります。

<div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/zmdHTsnzLMlOiW4eYBKC/image.png" alt=""><figcaption></figcaption></figure></div>

**【その他注意事項・説明等】**

* 出力されるCSVファイル名は、「\~.pdf.csv」「\~xlsx.csv」「\~xdw\.csv」の様に「対象のファイル名.拡張子.csv」となります。
* 出力されるCSVファイルはヘッダ行が出力されません。
* 出力されるCSVファイルは入力データー内の改行は全て削除されます。
* 出力フォルダーには自動帳票ファイル出力設定と同様に「{XXXX}」による置き換え文字を利用することができます。
* 設定内容を保存するには「この定義の出力項目設定を保存する」「この定義の出力項目設定を保存する（自動出力）」の両方を押してください。

  <div align="left"><figure><img src="https://content.gitbook.com/content/JOsI6lvNedHZoaBw5Ppf/blobs/WJ90lVYObLOyTPKsnADD/image.png" alt=""><figcaption><p>※2つのボタンを両方押してください。</p></figcaption></figure></div>
* フォルダ名には自動ファイル出力機能と同様に変数による指定が可能です。

{% hint style="success" %}
共有フォルダー関連の設定は省略することでローカルフォルダーへのファイルコピーに利用することも可能です。
{% endhint %}

{% hint style="warning" %}
ネットワーク障害等により共有フォルダーに接続できなかった場合はi-Reporterアプリからの帳票保存時にエラーが発生します。
{% endhint %}

### &#x20;**置換文字列について**

ファイル出力フォルダーには、置換文字列が使用できます。\
置換文字列を使用する事により、動的な出力フォルダーを作成する事が可能になります。\
置換文字列は、以下を用意しています。

<table><thead><tr><th width="246">置換文字列</th><th>置換される値</th></tr></thead><tbody><tr><td>{date}</td><td>入力完了時の日付yyyyMMdd形式</td></tr><tr><td>{dateTime}</td><td>入力完了時の日時yyyyMMddHHmmss形式</td></tr><tr><td>{time}</td><td>入力完了時の時刻HHmmss形式</td></tr><tr><td>{derTopId}</td><td>入力完了した入力帳票の帳票定義ＩＤ</td></tr><tr><td>{defTopName}</td><td>入力完了した入力帳票の帳票定義名称</td></tr><tr><td>{repTopId}</td><td>入力完了した入力帳票のＩＤ</td></tr><tr><td>{repTopName}</td><td>入力完了した入力帳票名称</td></tr><tr><td>{defTopName}</td><td>入力完了した入力帳票の帳票定義名称</td></tr><tr><td>{remarksValue1}</td><td>入力完了した入力帳票の備考１</td></tr><tr><td>       ……</td><td>入力完了した入力帳票の備考２～９</td></tr><tr><td>{remarksValue10}</td><td>入力完了した入力帳票の備考１０</td></tr><tr><td>{publicStatus}</td><td>入力完了した入力帳票の公開ステータス</td></tr></tbody></table>

{% hint style="success" %}
【設定例】

* 帳票定義ごとに出力する。\
  \\\Win-mjp61tgdle0\awfm\\{defTopName}\\
* 入力帳票ごとに出力する。\
  \\\Win-mjp61tgdle0\awfm \\{repTopName}\\
  {% endhint %}

{% hint style="success" %}
V5.0より、ファイル出力フォルダーに使用できる置換文字列を追加しました。

{date}, {dateTime},{time},{publicStatus}
{% endhint %}
