4. 機能説明¶

4.1. サービスの開始と停止¶

4.1.1. サービスの開始¶

Create!Form Magicfolder を利用するためにはサービスを開始する必要があります。初期設定ではマシンの起動時にサービスは自動で開始していますが、サービスのスタートアップの種類が手動になっていたり、サービスが停止している場合は以下の手順で開始してください。

4.1.1.1. Windows環境¶

Windows の [コントロールパネル] から [管理ツール] を開き、 [サービス] を開きます。
名前の列にある 「Create!Form Storage Service V11」 を右クリックして 「開始」 をクリックします。
名前の列にある 「Create!Form Commons Container Service V11」 を右クリックして 「開始」 をクリックします。

4.1.1.2. Linux環境¶

コマンド 「service cfmongod11 start」 を実行します。
コマンド 「service cfccd11 start」 を実行します。

4.1.2. サービスの停止¶

サービスを停止する場合は以下の手順で停止してください。サービスを停止すると管理画面へのアクセスや監視フォルダでのジョブの実行はできなくなります。

4.1.2.1. Windows環境¶

Windows の [コントロールパネル] から [管理ツール] を開き、 [サービス] を開きます。
名前の列にある 「Create!Form Commons Container Service V11」 を右クリックして 「停止」 をクリックします。
名前の列にある 「Create!Form Storage Service V11」 を右クリックして 「停止」 をクリックします。

4.1.2.2. Linux環境¶

コマンド 「service cfccd11 stop」 を実行します。
コマンド 「service cfmongod11 stop」 を実行します。

4.2. コマンドライン¶

Create!Form Magicfolder ではコマンドラインから以下の操作を行うことができます。

バージョン情報の表示
サービスの開始と停止
Create!Form Magicfolder の開始と停止
監視フォルダの制御

4.2.1. バージョン情報の表示¶

コマンドラインから製品のバージョン情報を確認します。

カレントディレクトリはプログラムディレクトリ直下にある 「bin」 ディレクトリに移動してください。

magicfolder --

4.2.2. サービスの開始と停止¶

コマンドラインからサービスの稼働状態を制御します。サービスを開始すると Create!Form Magicfolder も自動で開始します。サービスを停止すると管理画面へのアクセスや監視フォルダでのジョブの実行はできなくなります。

4.2.2.1. Windows環境¶

開始

net start cfmongod11
net start cfccd11

停止

net stop cfccd11
net stop cfmongod11

4.2.2.2. Linux環境¶

開始

service cfmongod11 start
service cfccd11 start

停止

service cfccd11 stop
service cfmongod11 stop

4.2.3. Create!Form Magicfolder の開始と停止¶

コマンドラインから Create!Form Magicfolder の稼働状態を制御します。停止すると監視フォルダでのジョブの実行はできなくなります。

カレントディレクトリはプログラムディレクトリ直下にある 「bin」 ディレクトリに移動してください。

開始

magicfolder start

停止

magicfolder stop

再起動

magicfolder restart

稼働状態の表示

magicfolder status

4.2.4. 監視フォルダの制御¶

コマンドラインから監視フォルダを制御します。

カレントディレクトリはプログラムディレクトリ直下にある 「bin」 ディレクトリに移動してください。

開始

magicfolder site [監視フォルダID] start

停止

magicfolder site [監視フォルダID] stop

一時停止

magicfolder site [監視フォルダID] suspend

監視状態の表示

magicfolder site [監視フォルダID] status

4.3. 導入ディレクトリ¶

4.3.1. プログラムディレクトリ¶

製品実行時に必要なプログラムモジュールファイルが格納されるディレクトリです。

初期設定では以下のディレクトリとなります。

4.3.1.1. Windows環境¶

C:\Program Files (x86)\Infotec\CreateForm\11

4.3.1.2. Linux環境¶

tarアーカイブを展開したディレクトリ

4.3.2. ユーザー設定ディレクトリ¶

製品実行時に必要な設定ファイル、製品実行時に変更されるファイルが格納されるディレクトリです。 iniファイル、ログ設定用ファイル、QDFファイル、データ編集定義ファイル、フォント情報定義ファイル、カラーパレットファイル、印刷詳細設定ファイル、PDFセキュリティ設定ファイルなどが含まれます。

初期設定では以下のディレクトリとなります。

4.3.2.1. Windows環境¶

C:\ProgramData\Infotec\CreateForm\11\conf\private

4.3.2.2. Linux環境¶

tarアーカイブを展開したディレクトリ/conf

4.3.3. ユーザーデータディレクトリ¶

Create!Formにより作成されるファイルが格納されるディレクトリです。実行ログ、ストレージなどのデータが含まれます。

初期設定では以下のディレクトリとなります。

4.3.3.1. Windows環境¶

C:\ProgramData\Infotec\CreateForm\11\var

4.3.3.2. Linux環境¶

tarアーカイブを展開したディレクトリ/var

4.3.4. 帳票ディレクトリ¶

サンプルの帳票資源ファイル、Create!Form Magicfolderで使用する帳票資源ファイルが格納されるディレクトリです。

初期設定では以下のディレクトリとなります。

4.3.4.1. Windows環境¶

C:\ProgramData\Infotec\CreateForm\11\work

4.3.4.2. Linux環境¶

tarアーカイブを展開したディレクトリ/work

4.4. ログインIDの変更¶

初期設定ではログインIDは「admin」ですが、任意のログインIDに変更することができます。

ログインIDを変更する場合は以下の操作を行ってください。

Create!Form Magicfolder のユーザー設定ディレクトリ内にある 「cfmf-server.properties」 ファイルを開きます。
「admin.id=新しいログインID」 の行を追加します。

cf.error.log.enable=false
job.available=30
log.append=true
log.enable=true
log.filename=cfmf.log
admin.id=createform          ←追加

ファイルを上書き保存します。
ログインIDが更新されましたので、新しく指定したログインIDでログイン可能となります。

4.5. ログオンアカウントの変更¶

Create!Form Magicfolder が稼働するために必要な Windows サービスは、初期設定では 「ローカルシステムアカウント」 が設定されています。

通常はローカルシステムアカウントのままで問題ありませんが、任意のログオンアカウントを設定することで、ログオンアカウントで許可されたディレクトリを参照したり、ネットワークドライブを参照したりすることができます。

ログオンアカウントの設定を変更する場合は以下の操作を行ってください。

Windows の [コントロールパネル] から [管理ツール] を開き、 [サービス] を開きます。
名前の列にある 「Create!Form Commons Container Service V11」 をダブルクリックします。
「ログオン」 タブをクリックし、 「アカウント」 を選択して 「ログオンアカウント」 と 「パスワード」 を指定します。
「OK」 ボタンをクリックして確定します。
サービスが稼働中の場合はサービスの再起動後にログオンアカウントが適用されます。

4.6. ログインパスワードのリセット¶

Create!Form Magicfolder のログインパスワードを忘れた場合は、ログインパスワードをリセットする必要があります。ログインパスワードをリセットすることで初期設定のパスワードでログインが可能となります。

ログインパスワードをリセットする場合は以下の操作を行ってください。

Create!Form Magicfolder のユーザー設定ディレクトリ内にある 「cfmf-server.properties」 ファイルを開きます。
「admin.password」 の行を削除します。

admin.auth=true
admin.password=21232f297a57a5a743894a0e4a801fc3          ←削除
cf.error.log.enable=false
job.available=30
log.append=true
log.enable=true
log.filename=cfmf.log

ファイルを上書き保存します。
ログインパスワードがリセットされましたので、初期設定のパスワードの 「admin」 でログイン可能となります。

4.7. Create!Form ランタイムの文字コード設定¶

監視フォルダへ投入するデータファイルの文字コードと Create!Form ランタイムの文字コード設定が異なる場合、出力される帳票の内容が文字化けする場合があります。この場合は、Create!Form ランタイムの文字コード設定が必要となります。

Create!Form ランタイムの文字コード設定を変更する場合は以下の操作を行ってください。

4.7.1. Windows環境の場合¶

Windowsのスタートメニューから[Create!Form V11]-[マネージャ]を起動します。
メニュー[設定]-[環境]をクリックします。
[文字コード/外字設定]タブをクリックし、Create!Form ランタイムの文字コードを設定します。

4.7.2. Linux環境の場合¶

環境変数の設定ファイル 「/etc/cfccd11.conf」 を vi などで開きます。

# vi /etc/cfccd11.conf

「i」 キーを入力して編集モードにします。
環境変数 「CREATE_LANG」 を設定する文字コードに変更します。

文字コード
SJIS
EUC
UTF16
UTF8

「ESC」 キーを入力後、 「Shift」 キーを押しながら 「Z」 キーを2回入力して保存します。
以下のコマンドを実行してサービスを再起動します。

# service cfccd11 restart

4.8. Create!Formプリンタ¶

Create!Formプリンタとは、Create!Formのマネージャから登録したプリンタです。

プリンタは 「default」 または 「PRT」 から始まるプリンタ名で表され、Windowsのプリンタドライバと紐付けてプリンタを登録します。 Create!Formプリンタを登録することで、プリンタの給紙トレイの割り当てを詳細に設定することができます。

Create!Formプリンタを登録する場合は以下の操作を行ってください。

Windowsのスタートメニューから[Create!Form V11]-[マネージャ]を起動します。
メニュー[設定]-[プリンタ]をクリックします。
「default」 または 「PRT」 を選択し、任意のプリンタを割り当てます。
給紙トレイの割り当てを行う場合は、[トレイ設定]ボタンをクリックします。

4.9. 監視状態¶

監視フォルダには監視状態として 「開始」 「一時停止」 「停止」 の状態があります。状態に応じて監視フォルダは以下のように動作します。

開始: 監視フォルダへ投入された入力データファイルは自動で回収され、処理が行われます。ただし、監視フォルダにスケジュールが設定されている場合、スケジュール時間外はファイルを回収しません。
一時停止: 監視フォルダへ投入された入力データファイルは自動で回収されますが、監視状態が開始となるまで処理は待機します。ただし、監視フォルダにスケジュールが設定されている場合、スケジュール時間外はファイルを回収しません。
停止: 監視フォルダへ投入された入力データファイルは回収しません。

4.10. 実行モード¶

ジョブには 「PDF」 「印刷」 「印刷 (PostScript)」 「Excel」 「クライアント印刷」 の実行モードがあります。実行モードに応じて以下のように帳票を出力します。

PDF: 指定した出力先ディレクトリへPDFファイルを出力します。
印刷: Windows のプリンタドライバへ印刷します。
印刷 (PostScript): PostScript プリンタへ印刷します。
Excel: 指定した出力先ディレクトリへXLSXファイルを出力します。
クライアント印刷: 指定した出力先ディレクトリへCCDファイルを出力します。

注意

ジョブに設定されている実行モードをファイル出力から印刷、印刷からファイル出力へ切り替えることはできません。

ヒント

「印刷」 はWindows環境でのみ利用可能です。

パラメータ取得ルール機能を使用して実行モードを指定する場合は、以下の値を指定してください。

PDF: Cast
印刷: PrintStage
印刷 (PostScript): Print
Excel: Expage
クライアント印刷: PrintStage Web

4.11. ファイルパターン¶

監視フォルダで処理対象にするファイルの拡張子を限定する機能です。 「*」 を指定すると、すべてのファイルが処理対象となります。 「*.csv」 と指定すると、ファイルの拡張子が 「csv」 のファイルのみ処理対象となります。

4.12. 実行済みジョブの有効期限¶

実行済みジョブの有効期限とは、実行が完了したジョブをストレージから自動で削除するための設定です。

例えば、実行済みジョブの有効期限として 「1日」 と設定した場合、実行が完了してから1日後にストレージから自動で削除されます。削除されたジョブはジョブのプロパティを参照したり再実行したりすることはできません。

一方、実行済みジョブの有効期限を 「無期限」 と設定した場合、ジョブを明示的に削除するまでジョブは削除されません。

ヒント

この設定は Create!Form RemoteObject からジョブを参照する場合に利用します。

4.13. パラメータ取得ルール機能¶

監視フォルダ内に生成されたファイルをどのような設定で帳票出力するかは、監視フォルダのランタイム設定であらかじめ指定しておいた内容に従います。加えてデータファイルの内容から設定情報を取得して処理を行うこともできます。

例えば、監視フォルダの設定にはジョブファイル名の指定は行わず、データファイルの先頭行にジョブファイル名を記述することによって、データファイルごとに出力する帳票の種類を切り替えるといったことが実現できます。

このような仕組みを実現する機能が「パラメータ取得ルール」機能です。この機能を利用する場合は、監視フォルダ情報画面の 「ルール」 タブで設定を行います。

ここで指定することができるパラメータについてはパラメータをご覧ください。

4.14. ファイル名からパラメータを取得¶

監視フォルダへ投入したファイルのファイル名をパラメータとして取得する機能です。

例えば、以下のようなCSVファイルを監視フォルダへ投入するとします。

D07_sheet-Printer-20.csv

ファイル名をパラメータとして取得する場合、ジョブファイル名「D07_sheet」、プリンタ名「Printer」、印刷部数「20」といったようにファイル名から帳票出力を制御できます。

注意

監視フォルダへ投入するファイルには拡張子が必要です。

4.14.1. 区切り文字の扱い¶

監視フォルダの初期設定では、区切り文字をファイル名の先頭や末尾および連続して指定することができます。(「.PRT1..sheet..csv」など)

従来のようにファイル名の先頭や末尾の区切り文字を省略したり、連続した区切り文字を1つの区切り文字として扱いたい場合は、監視フォルダ情報画面の 「拡張設定」 タブへ以下の設定を追加してください。

パラメータ:	ext.filename.token
設定値:	false

4.15. ファイル先頭行からパラメータを取得¶

監視フォルダへ投入したファイルの先頭行をパラメータとして取得する機能です。

例えば、以下のようなCSVファイルを監視フォルダへ投入するとします。

D07_sheet
Printer
20
社員台帳1ページ分のデータ
0000001,1994/08/01,インサツ ハナコ,印刷  花子,1972/03/10
25,女,無,0425-65-3378,自
〒191-0088,東京都,国立市富士見町3-5-46,エスカルゴハイツ201号室,賃貸
〒120-7700,静岡県,清水市青葉瀬町白鞍ヶ谷1-1024,
2時間10分,自宅～<徒歩>～富士見小学校前～<都営バス>～国立駅～<JR中央線>～新宿～<徒歩>～新宿事業所
1987年4月 ～ 1990年3月,緑山高校,,普通科,卒業
1990年4月 ～ 1994年3月,緑山学院大学,法学部,法学科,卒業

ファイルの先頭3行をパラメータとして取得する場合、ジョブファイル名「D07_sheet」、プリンタ名「Printer」、印刷部数「20」といったようにファイルの先頭行から帳票出力を制御できます。

注意

「ファイル名からパラメータを取得」 と 「ファイル先頭行からパラメータを取得」 で同一のパラメータが設定されている場合、 「ファイル名からパラメータを取得」 が優先されます。

注意

ファイルの先頭に BOM が付加されている場合は文字コードが自動判別されますが、BOM が付加されていない場合や BOM のない文字コードを使用する場合は Windows 環境では 「SJIS」 、Linux 環境では環境変数 「CREATE_LANG」 の設定値が文字コードの初期値となります。 UTF-8 (BOMなし) または UTF-16 LE (BOMなし) の文字コードを使用する場合や Linux 環境で SJIS や EUC の文字コードを使用する場合は、監視フォルダ情報画面の 「拡張設定」 タブへ以下の設定を追加してください。

パラメータ:	input.file.charcode
設定値:	SJIS、EUC、UTF-8、UTF-16

4.16. アノテーション¶

監視フォルダへ投入したファイルの先頭行をパラメータとして取得する機能です。

アノテーションでは、ファイルの先頭行に 「<cf:mf-annotation>」 という開始タグを記述し、 「</cf:mf-annotation>」 の閉じタグを記述する範囲にパラメータを指定することができます。

<cf:mf-annotation>
cf.opt.s = D07_sheet
cf.opt.# = Printer
cf.opt.nc = 20
</cf:mf-annotation>
社員台帳1ページ分のデータ
0000001,1994/08/01,インサツ ハナコ,印刷  花子,1972/03/10
25,女,無,0425-65-3378,自
〒191-0088,東京都,国立市富士見町3-5-46,エスカルゴハイツ201号室,賃貸
〒120-7700,静岡県,清水市青葉瀬町白鞍ヶ谷1-1024,
2時間10分,自宅～<徒歩>～富士見小学校前～<都営バス>～国立駅～<JR中央線>～新宿～<徒歩>～新宿事業所
1987年4月 ～ 1990年3月,緑山高校,,普通科,卒業
1990年4月 ～ 1994年3月,緑山学院大学,法学部,法学科,卒業

アノテーションを使用することでファイルの先頭行数を固定せず、また6行以上の行数をパラメータ指定に使用することができるため、より柔軟にパラメータを指定することができます。

また、以下のように独自のパラメータを定義し、監視フォルダの拡張オプションやフィルタ機能などで「${username}」や「${groupname}」のように指定することで、独自のパラメータが展開されます。

<cf:mf-annotation>
username = 帳票太郎
groupname = 営業部
</cf:mf-annotation>
…(略)…

4.17. フィルタ機能¶

監視フォルダの処理では、Create!Form ランタイム実行の前後にそれぞれ任意の処理を付加することができます。例えば帳票出力前にデータファイルの内容を帳票出力用に加工したり、出力されたPDF帳票をメール送信させるといったことが実現できます。

このような仕組みを実現する機能が「フィルタ」機能です。この機能を利用する場合は、監視フォルダ情報画面の 「フィルタ」 タブで設定を行います。

監視フォルダからファイルが回収されたタイミングおよび帳票出力(出力ランタイムの実行)の前後にフィルタを登録することができます。

監視フォルダからファイルが回収されたタイミングで処理を行う場合はフィルタ(ファイル検知時) 、帳票出力の前に処理を行う場合はフィルタ(実行前) 、後に処理を行う場合はフィルタ(実行後) にそれぞれ追加していきます。

4.18. フィルタ(ファイル検知時)¶

監視フォルダで入力データファイルが回収された直後に任意の処理を実行させるための機能です。最大で10個のフィルタを登録することができます。

利用可能なフィルタは以下の通りです。

プログラム実行
データファイル分割
データファイル挿入
改行コード変換

4.19. フィルタ(実行前)¶

Create!Form ランタイムによる帳票の出力前に任意の処理を実行させるための機能です。最大で9個のフィルタを登録することができます。

利用可能なフィルタは以下の通りです。

プログラム実行

4.20. フィルタ(実行後)¶

Create!Form ランタイムによる帳票の出力後に任意の処理を実行させるための機能です。最大で9個のフィルタを登録することができます。

利用可能なフィルタは以下の通りです。

プログラム実行
メール送信

4.20.1. 入力データファイルの参照(${in})¶

ファイル先頭行ルールが有効な状態で入力データファイルをパラメータ「${in}」で参照する場合、監視フォルダの初期設定ではファイル先頭行ルールの行を含めた投入時の元のデータファイルを参照することができません。参照すると、ファイル先頭行ルールの行が取り除かれた状態のデータファイルとなります。

ファイル先頭行ルールの行を含めた投入時の元のデータファイルを参照したい場合、監視フォルダ情報画面の 「拡張設定」 タブへ以下の設定を追加してください。

パラメータ:	ext.in.backup
設定値:	true

4.21. プログラム実行¶

任意のプログラムを実行するためのフィルタです。

実行コマンド: 実行するプログラムのコマンドラインを指定します。

注意

Windows の標準コマンド「move」「copy」などをコマンドラインで使用する場合、「cmd.exe /c copy ${in} C:backup」のように「cmd.exe」上で実行するように記述する必要があります。さらに、「/c」オプションで、コマンド実行後に自動的に終了するようにしておきます。コマンド実行後に実行したプログラムが自動的に終了しない場合、以降の監視フォルダの処理が実行されなくなります。

任意で呼び出した外部のプログラムも同様に、実行後に自動的に終了するようなプログラムである必要があります。特に、GUI(ユーザインタフェース)を持つプログラムを呼び出す場合、実行後に自動的に終了しない可能性がありますので、十分に注意してください。

4.22. データファイル分割¶

指定した条件によって入力データファイルを分割するためのフィルタです。入力データファイルを分割すると、分割した入力データファイル単位で Create!Form ランタイムが実行されます。

注意

文字コードは 「SJIS」 「UTF-8」 「UTF-16」 のみ対応しています。 UTF-8 (BOMなし) または UTF-16 LE (BOMなし) の文字コードを使用する場合や Linux 環境で SJIS の文字コードを使用する場合は、監視フォルダ情報画面の 「拡張設定」 タブへ以下の設定を追加してください。

パラメータ:	input.file.charcode
設定値:	SJIS、UTF-8、UTF-16

注意

入力データファイルの区切り文字と制御文字はそれぞれ「,」と「”」が使用されます。区切り文字と制御文字を任意の文字へ変更したい場合は、監視フォルダ情報画面の 「拡張設定」 タブへ以下の設定を追加してください。

パラメータ:	input.file.csv.separator
設定値:	任意の区切り文字 (タブを指定する場合は \t を指定)
パラメータ:	input.file.csv.control
設定値:	任意の制御文字

注意

データファイルの分割中にエラーが発生した場合、分割処理は中断され、以降のフィルタ処理や Create!Form ランタイムの実行は行われません。また、「ファイル先頭行からパラメータを取得」や「アノテーション」が有効な場合、これらの先頭行のデータはデータファイル分割の行数には含まれません。そのため、これらの先頭行の終わりの次の行がデータファイル分割の1行目として扱われます。分割したファイルにはそれぞれこれらの先頭行のデータが自動的に付加されます。

分割条件

入力データファイルの分割条件として 「キーブレイク毎に分割する」 「指定した行数毎に分割する」 「条件値と一致する毎に分割する」 のいずれかを選択します。

「キーブレイク毎に分割する」 を選択した場合、キー項目のデータがキーブレイクする毎に入力データファイルを分割します。キー項目の設定は、「1列目」「2列目」といった列による指定や、「1ページ10行中の3行1列目」といった各ページ毎の行と列による指定が可能です。

「指定した行数毎に分割する」 を選択した場合、指定した行数毎に入力データファイルを分割します。「3行」や「10行」といった分割行数を指定して入力データファイルを分割します。

「条件値と一致する毎に分割する」 を選択した場合、キー項目のデータが条件値と一致する毎に分割します。条件値との一致の判定は、「1列目」「2列目」といった列による指定や、各ページ毎の行と列による指定が可能です。

入力データ種別

入力データファイルのデータ種別として 「CSV」 「テキスト」 のいずれかを選択します。

入力データファイルがCSV形式の場合は 「CSV」 を選択し、テキスト形式の場合は 「テキスト」 を選択します。