eDocArrangement2Command
eDocArrangement2の処理をコマンドラインから実行する場合は「eDocArrangement2Command.exe」を使用します。「eDocArrangement2Command.exe」はインストールフォルダにインストールされています。事前にeDocArrangement2の設定で処理を作成後、設定名を引数に起動することで処理を実行できます。書式は以下の通りです。
| オプション | 説明 |
|---|---|
| -p 設定名 | 設定名を指定します。以下のようにスイッチと設定名をセットで複数指定できます。 -p 設定名1 -p 設定名2 |
| -f ファイル名 |
設定に渡すファイル名を指定します。ワイルドカードに対応しています。 以下のようにスイッチとファイル名をセットで複数指定できます。 -f ファイル名1 -f ファイル名2 |
| -r | 指定したファイル名をサブフォルダを含めて検索します。 |
| -g 正規表現 |
対象フォルダを絞り込む正規表現を指定します。 -r を指定した時に適用されます。 詳細は スケジュール設定の対象フォルダ(正規表現) を参照してください。 |
| -s | マクロ実行などでダイアログの表示が行われません。サービスから実行する場合に指定します。 |
| -o | 設定に任意の文字列を渡す場合に指定します。渡した文字列は{%GET(OptionString)}で取得できます。 |
| -utf8 | 標準出力をUTF-8エンコーディングで出力します。省略時はシステムデフォルト(Shift_JIS)で出力します。 |
eDocArrangement2のコマンド実行やコマンド実行マクロから、eDocArrangement2Command.exeを呼び出し、指定した設定を実行することも可能ですが、その場合はログファイルを同じファイルにしないでください。
例1
eDocArrangement2Command -p ログ集計 -f c:\Log\*.log
例2
eDocArrangement2Command -p マスタ読み込み
リターンコード
コマンド実行後に発生したエラーは以下のリターンコードで確認できます。
| リターンコード | 内容 |
|---|---|
| 0 | 正常 |
| -1 | pスイッチ引数は必ず指定してください。 |
| -2 | pスイッチで指定された設定名が見つかりません。 |
| -3 | fスイッチで指定されたフォルダが見つかりません。 |
| -4 | fスイッチで指定されたファイルが見つかりません。 |
| -5 | gスイッチで指定された正規表現でエラーが発生しました。 |
| -90 | 設定ファイルの読み込みエラー。 |
| -91 | 試用期限を過ぎています。 |
| -99 | 予期せぬエラーが発生しました。 |
設定管理コマンド (-config)
eDocArrangement2の設定をコマンドラインからJSON形式でエクスポート・インポートすることができます。設定の移行やバックアップ、CIでの自動デプロイ等に利用できます。書式は以下の通りです。
設定の更新操作（import、import-all、remove、remove-all）は、以下の場合にエラーになります。更新操作を行う場合は、該当するアプリケーションを終了してから実行してください。参照操作（list、export、export-all）は実行中でも使用できます。
- eDocArrangement2（メイン画面）が起動中の場合 ※schedule以外の対象への更新時
- eDocArrangement2 Schedulerが起動中またはスケジュール実行中の場合 ※scheduleへの更新時
- eDocArrangement2サービスが実行中の場合
- 別のeDocArrangement2Commandが設定を更新中の場合
-db または -scheduledb でシステムデフォルト以外のDBファイルを指定している場合は、上記のチェックはスキップされます。
対象と操作の組み合わせで実行する処理を指定します。
対象 (target)
| 対象 | 説明 |
|---|---|
| home | 共通設定を操作します。 |
| batch | バッチ設定を操作します。 |
| database | データベース設定を操作します。 |
| mailserver | メールサーバー設定を操作します。 |
| seqno | 連番設定を操作します。 |
| schema | 埋め込みスキーマファイルを操作します。 |
| schedule | スケジュール設定を操作します。スケジュール設定は別のDBファイル(eDocArrangement2Schedule.db)に保存されています。 |
| all | 全設定（共通設定＋データベース設定＋メールサーバー設定＋連番設定＋バッチ設定）を一括で操作します。 |
共通設定 (home)
| コマンド | 説明 |
|---|---|
| -config home export [-json ファイル] |
共通設定をJSON形式でエクスポートします。 -json を省略すると標準出力に出力されます。 |
| -config home import -json ファイル | JSONファイルから共通設定をインポートします。既存の共通設定は上書きされます。 |
例: 共通設定のエクスポート
eDocArrangement2Command -config home export -json C:\backup\home_settings.json
バッチ設定 (batch)
| コマンド | 説明 |
|---|---|
| -config batch list | 登録済みの全バッチ設定名を一覧表示します。設定フォルダがある場合は [Folder] 付きで階層表示されます。 |
| -config batch export -name 設定名 [-json ファイル] |
指定したバッチ設定またはフォルダをJSON形式でエクスポートします。 フォルダ内のバッチも名前で検索して見つけ出します。フォルダを指定した場合はフォルダ内の全バッチを含めてエクスポートします。 バッチがフォルダ内にある場合、JSONに "parent" フィールド（親フォルダ名）が含まれます。このJSONをそのままインポートすると、同じフォルダ内にインポートされます。 -json を省略すると標準出力に出力されます。 |
| -config batch export-all [-json ファイル] |
全バッチ設定をフォルダ構造を含めて一括でJSON形式にエクスポートします。 -json を省略すると標準出力に出力されます。 |
| -config batch import -json ファイル [-force] |
JSONファイルからバッチ設定またはフォルダをインポートします。 同名のバッチまたはフォルダが既に存在する場合はエラーになります。-force を指定すると上書きします。-force で上書きした場合、元の並び順が維持されます。 JSONに "parent" フィールドが指定されている場合、指定されたフォルダ内にインポートします。"parent" を省略した場合はルート直下にインポートします。-force で上書きする場合は、既存の設定が存在するフォルダにインポートされるため、"parent" の指定は不要です。 フォルダをインポートする場合、フォルダ内のバッチ名・サブフォルダ名も既存設定との重複チェックが行われます。 |
| -config batch import-all -json ファイル [-force] |
JSONファイルから全バッチ設定をフォルダ構造を含めて一括でインポートします。 既存のバッチ設定が存在する場合はエラーになります。-force を指定すると既存設定を削除してからインポートします。-force で上書きした場合、元の並び順が維持されます。 各バッチに "parent" フィールドが指定されている場合、指定されたフォルダ内にインポートします。 |
| -config batch remove -name 設定名 | 指定したバッチ設定またはフォルダを削除します。フォルダを指定した場合はフォルダ内の全バッチも削除されます。フォルダ内のバッチも名前で検索して見つけ出します。 |
| -config batch remove-all | 全バッチ設定をフォルダを含めて一括で削除します。 |
例: バッチ設定のエクスポートとインポート
eDocArrangement2Command -config batch export -name ログ集計 -json C:\backup\log_batch.json eDocArrangement2Command -config batch import -json C:\backup\log_batch.json -force
データベース設定 (database)
| コマンド | 説明 |
|---|---|
| -config database list | 登録済みの全データベース設定名を一覧表示します。 |
| -config database export -name 設定名 [-json ファイル] |
指定したデータベース設定をJSON形式でエクスポートします。 -json を省略すると標準出力に出力されます。 |
| -config database export-all [-json ファイル] |
全データベース設定を一括でJSON形式にエクスポートします。 -json を省略すると標準出力に出力されます。 |
| -config database import -json ファイル [-force] |
JSONファイルからデータベース設定をインポートします。 同名の設定が既に存在する場合はエラーになります。-force を指定すると上書きします。 ユーザーDBファイルパス（txtDatabaseUserDbPath）は必須です。空の場合はエラーになります。 |
| -config database import-all -json ファイル [-force] |
JSONファイルから全データベース設定を一括でインポートします。 既存の設定が存在する場合はエラーになります。-force を指定すると既存設定を削除してからインポートします。 |
| -config database remove -name 設定名 | 指定したデータベース設定を削除します。 |
| -config database remove-all | 全データベース設定を一括で削除します。 |
例: データベース設定のエクスポートとインポート
eDocArrangement2Command -config database export -name ユーザーDB -json C:\backup\userdb.json eDocArrangement2Command -config database import -json C:\backup\userdb.json -force
メールサーバー設定 (mailserver)
| コマンド | 説明 |
|---|---|
| -config mailserver list | 登録済みの全メールサーバー設定名を一覧表示します。 |
| -config mailserver export -name 設定名 [-json ファイル] |
指定したメールサーバー設定をJSON形式でエクスポートします。 -json を省略すると標準出力に出力されます。 |
| -config mailserver export-all [-json ファイル] |
全メールサーバー設定を一括でJSON形式にエクスポートします。 -json を省略すると標準出力に出力されます。 |
| -config mailserver import -json ファイル [-force] |
JSONファイルからメールサーバー設定をインポートします。 同名の設定が既に存在する場合はエラーになります。-force を指定すると上書きします。 |
| -config mailserver import-all -json ファイル [-force] |
JSONファイルから全メールサーバー設定を一括でインポートします。 既存の設定が存在する場合はエラーになります。-force を指定すると既存設定を削除してからインポートします。 |
| -config mailserver remove -name 設定名 | 指定したメールサーバー設定を削除します。 |
| -config mailserver remove-all | 全メールサーバー設定を一括で削除します。 |
例: メールサーバー設定のエクスポートとインポート
eDocArrangement2Command -config mailserver export -name 社内SMTP -json C:\backup\mailsrv.json eDocArrangement2Command -config mailserver import -json C:\backup\mailsrv.json -force
連番設定 (seqno)
| コマンド | 説明 |
|---|---|
| -config seqno list | 登録済みの全連番設定名を一覧表示します。 |
| -config seqno export -name 設定名 [-json ファイル] |
指定した連番設定をJSON形式でエクスポートします。 連番の共有が有効な場合、共有ファイル（TreeDB）から現在の連番を読み取り、エクスポートデータに反映します。 -json を省略すると標準出力に出力されます。 |
| -config seqno export-all [-json ファイル] |
全連番設定を一括でJSON形式にエクスポートします。 -json を省略すると標準出力に出力されます。 |
| -config seqno import -json ファイル [-force] |
JSONファイルから連番設定をインポートします。 連番の共有が有効な場合、共有ファイル（TreeDB）に連番を書き込みます。共有ファイルのパスが指定されていない場合はエラーになります。フォルダが存在しない場合は自動的に作成されます。 同名の設定が既に存在する場合はエラーになります。-force を指定すると上書きします。 |
| -config seqno import-all -json ファイル [-force] |
JSONファイルから全連番設定を一括でインポートします。 既存の設定が存在する場合はエラーになります。-force を指定すると既存設定を削除してからインポートします。 |
| -config seqno remove -name 設定名 | 指定した連番設定を削除します。 |
| -config seqno remove-all | 全連番設定を一括で削除します。 |
例: 連番設定のエクスポートとインポート
eDocArrangement2Command -config seqno export -name 請求書番号 -json C:\backup\seqno.json eDocArrangement2Command -config seqno import -json C:\backup\seqno.json -force
スケジュール設定 (schedule)
スケジュール設定は別のDBファイル(eDocArrangement2Schedule.db)に保存されています。-scheduledb オプションで別のスケジュールDBファイルを指定することもできます。
| コマンド | 説明 |
|---|---|
| -config schedule list | 登録済みの全スケジュール設定名を一覧表示します。 |
| -config schedule export -name 設定名 [-json ファイル] |
指定したスケジュール設定をJSON形式でエクスポートします。 -json を省略すると標準出力に出力されます。 |
| -config schedule export-all [-json ファイル] |
全スケジュール設定（スケジューラ共通設定を含む）を一括でJSON形式にエクスポートします。 -json を省略すると標準出力に出力されます。 |
| -config schedule import -json ファイル [-force] |
JSONファイルからスケジュール設定をインポートします。 同名のスケジュールが既に存在する場合はエラーになります。-force を指定すると上書きします。 |
| -config schedule import-all -json ファイル [-force] |
JSONファイルから全スケジュール設定（スケジューラ共通設定を含む）を一括でインポートします。 既存の設定が存在する場合はエラーになります。-force を指定すると既存設定を削除してからインポートします。 |
| -config schedule remove -name 設定名 | 指定したスケジュール設定を削除します。 |
| -config schedule remove-all | 全スケジュール設定を一括で削除します。スケジューラ共通設定は削除されません。 |
例: スケジュール設定のエクスポートとインポート
eDocArrangement2Command -config schedule export -name スケジュール1 -json C:\backup\schedule1.json eDocArrangement2Command -config schedule import -json C:\backup\schedule1.json -force eDocArrangement2Command -config schedule export-all -json C:\backup\schedules_all.json
スキーマ (schema)
| コマンド | 説明 |
|---|---|
| -config schema export [-json ファイル] |
eDocArrangement2Lib.dllに埋め込まれたスキーマファイル(eDocArrangement2_schema.json)をエクスポートします。 -json を省略すると標準出力に出力されます。 |
例: スキーマファイルのエクスポート
eDocArrangement2Command -config schema export -json C:\temp\schema.json
全設定 (all)
| コマンド | 説明 |
|---|---|
| -config all export [-json ファイル] |
共通設定・データベース設定・メールサーバー設定・連番設定・バッチ設定をまとめてJSON形式でエクスポートします。 -json を省略すると標準出力に出力されます。 |
| -config all import -json ファイル [-force] |
JSONファイルから共通設定・データベース設定・メールサーバー設定・連番設定・バッチ設定を一括でインポートします。 既存の設定が存在する場合はエラーになります。-force を指定すると既存設定を削除してからインポートします。 |
例: 全設定のバックアップと復元
eDocArrangement2Command -config all export -json C:\backup\all_settings.json eDocArrangement2Command -config all import -json C:\backup\all_settings.json -force
共通オプション
| オプション | 説明 |
|---|---|
| -json ファイル | 入出力するJSONファイルのパスを指定します。エクスポート時に省略すると標準出力に出力されます。 |
| -name 設定名 | 操作対象の設定名を指定します。batch、database、mailserver、seqno、schedule の各対象で使用します。 |
| -force | インポート時に既存の設定がある場合、上書きします。バッチ設定の場合、元の並び順が維持されます。 |
| -schema ファイル | バリデーション用のスキーマファイルのパスを指定します。省略時はeDocArrangement2Lib.dllの埋め込みリソースから読み込みます。 |
| -db DBファイル | 操作対象のeDocArrangement2.dbファイルのパスを指定します。省略時はシステムにインストールされた設定ファイルを使用します。 |
| -scheduledb DBファイル | 操作対象のeDocArrangement2Schedule.dbファイルのパスを指定します。省略時はシステムにインストールされた設定ファイルを使用します。-config schedule で使用します。 |
| -utf8 | 標準出力をUTF-8エンコーディングで出力します。省略時はシステムデフォルト(Shift_JIS)で出力します。 |
設定管理コマンドのリターンコード
-config コマンドで発生したエラーは以下のリターンコードで確認できます。
| リターンコード | 内容 |
|---|---|
| 0 | 正常 |
| -10 | コマンドの引数エラー。対象や操作の指定が不正です。 |
| -11 | JSONファイルまたはスキーマファイルの読み込みエラー。 |
| -12 | JSONの解析・バリデーションエラー。同名の設定が既に存在する場合を含みます。 |
| -13 | 指定された設定が見つかりません。 |
| -14 | 既存の設定が存在します。-force オプションを指定してください。 |
| -92 | eDocArrangement2サービスが実行中です。サービスを停止してください。 |
| -93 | eDocArrangement2 Schedulerが起動中またはスケジュール実行中です。Schedulerを終了してください。 |
| -94 | eDocArrangement2（メイン画面）が起動中です。eDocArrangement2を終了してください。 |
| -95 | 別のeDocArrangement2Commandが設定を更新中です。完了するまでお待ちください。 |