SDI コマンドライン・インタフェース(CLI)
概要
SdiCli.exeで、保存したマッピングの実行、設定の参照、連携設定案の検証・生成・適用、実行履歴の確認を行います。操作はコマンドとオプションで指定します。マッピングを実行する場合は、名前またはIDだけを指定する方法もあります。
標準インストール先は C:\Program Files\RiCCT\SimpleDataIntegrator です。以下は、そのフォルダーに移動するか、実行ファイルのフルパスを指定して実行してください。
利用前の設定
事前にStudioで初期設定と、必要な顧客管理キーの登録を完了してください。CLIは設定を自動初期化せず、管理キーも変更しません。
保存したマッピングを実行する
コマンドとオプションを指定する
SdiCli.exe mapping list --format json
SdiCli.exe mapping show --id M001 --format json
SdiCli.exe mapping exe --id M001 --request-id RUN-001 --format json
SdiCli.exe mapping exe --name "EMP_TO_EMPLOYEE" --request-id RUN-002 --format json
M001などは実際のIDに置き換えてください。--idと--nameは一方だけ指定します。名前は完全一致で検索し、複数候補がある場合は実行せずIDでの指定を求めます。
同じ --request-id を再送すると前回結果を返し、二重実行を防ぎます。異なる連携・再実行には新しいIDを使ってください。中断などで前回結果が不明の場合、自動再実行しません。実行ログを確認してから次の操作を判断します。CLIからの --timeout-seconds による中断には対応していません。
手動の mapping exe では、Studioで設定・保存したマッピングを実行できます。API入力マッピングや列の値・変換設定を含むマッピングも実行できます。
マッピング名またはIDだけを指定する
SdiCli.exe "EMP_TO_EMPLOYEE"
SdiCli.exe "MBE5B7F93B8E84B70B4D3AFDF229E1A35"
この形式は、マッピング名またはIDを1引数で指定して実行します。追加のオプションは指定できません。
| 戻り値(名前/IDだけを指定した場合) | 意味 |
|---|---|
| 0 | 正常終了 |
| 1 | 実行失敗 |
| 2 | 対象マッピングが見つからない |
コマンド一覧とJSON結果
SdiCli.exe system help --format json
SdiCli.exe system capabilities --format json
SdiCli.exe system inspect --format json
system helpでコマンド・必須引数・共通オプション、system capabilitiesで対応範囲、system inspectで実行環境とライセンス状態を確認します。--format jsonは結果の形式を指定するもので、AIモードへの切替ではありません。
| JSON項目 | 内容 |
|---|---|
schemaVersion / cliVersion |
結果形式とCLIのバージョン |
action / caller |
操作名と呼出区分(manual/ai) |
status |
ok、needs_input、error |
data |
操作結果 |
issues / nextActions |
エラー・警告と必要な次の操作 |
operationId |
実行した場合のOperation ID。Studioの実行ログと関連付けられます。実行前エラーなどでは省略します。 |
コマンドとオプションを指定する形式では、終了コード0が正常終了です。非0の場合は、JSONの status と issues も確認してください。例えば3は入力の見直しが必要、7は連携実行失敗、8は実行結果不明、9は未対応機能です。
接続・メタデータ・列候補
SdiCli.exe connection list --format json
SdiCli.exe connection show --id C001 --format json
SdiCli.exe connection test --id C001 --format json
SdiCli.exe metadata tables --connection-id C001 --schema public --format json
SdiCli.exe metadata columns --connection-id C001 --schema public --table emp --format json
SdiCli.exe schema get --name mapping-draft --format json
SdiCli.exe mapping suggest-columns --file mapping-draft.json --format json
列候補の提案は、自動的に運用設定へ保存しません。MappingSpecのメタデータがあればオフラインで照合し、ない側は登録済みConnectionへ接続して列を確認します。単独のMappingSpecの connectionRef は登録済みConnection IDです。
設定案の作成・検証・適用
SdiCli.exe schema get --name integration-plan --format json
SdiCli.exe plan template --type table-merge --output plan.json --format json
SdiCli.exe plan validate --file plan.json --level static --format json
SdiCli.exe plan generate --file plan.json --mode draft --output-dir .\draft --format json
テンプレートを実際の接続情報・テーブル・列対応に合わせて編集します。静的検証とdraft生成はDBへ接続しません。draftは実DB未照合のため、そのまま適用できません。
パスワードはPlanに平文で記述せず、対話可能なターミナルで設定します。この操作をJSON出力・リダイレクトと組み合わせないでください。
SdiCli.exe connection set-secret --plan-file plan.json --connection-ref source-db
秘密情報は実行ユーザーのDPAPIで保護されたローカル参照として記録します。別ユーザーや別PCでは改めて設定してください。
SdiCli.exe plan validate --file plan.json --level connected --format json
SdiCli.exe plan diff --file plan.json --level connected --format json
SdiCli.exe plan generate --file plan.json --mode deployable --output-dir .\generated --format json
SdiCli.exe plan apply --manifest .\generated\manifest.json --format json
connectedで実DBの構造を照合し、deployableで適用可能な設定一式とmanifestを生成します。生成先は運用設定フォルダーとは別にしてください。applyは接続・マッピング・スケジューラー設定を変更します。適用時にはメタデータ、既存設定のハッシュ、生成物とPlanの一致を再確認します。
保存はファイル単位で行い、ジャーナルを残します。途中失敗した場合は、結果に示された適用IDを使って調査・復旧します。
SdiCli.exe plan recover --apply-id APPLY001 --action inspect --format json
SdiCli.exe plan recover --apply-id APPLY001 --action rollback --format json
復旧が必要な間はStudio・Workerを起動しないでください。rollbackの対象は設定ファイルであり、連携先DBのデータを戻すものではありません。
スケジュール・実行履歴
SdiCli.exe schedule list --format json
SdiCli.exe schedule show --id S001 --format json
SdiCli.exe schedule preview --file plan.json --count 5 --format json
SdiCli.exe worker status --format json
SdiCli.exe execution list --mapping-id M001 --format json
SdiCli.exe execution show --id OPERATION_ID --format json
SdiCli.exe report generate --manifest .\generated\manifest.json --output-dir .\report --format json
OPERATION_IDは実行結果の operationId で置き換えます。新規スケジューラーは無効で生成されます。予定時刻はWorkerのローカル時刻で計算し、実際に実行・成功したことを示すものではありません。既存スケジュールの有効化には、現在の設定ハッシュを指定します。
SdiCli.exe schedule set-enabled --id S001 --enabled true --expected-hash CURRENT_HASH --format json
レポートは生成時点の結果をまとめます。全件の値照合を自動実行する機能ではなく、取得できない件数を推測して表示することもありません。
AIから操作する場合
AIからコマンドを呼び出す場合は、値なしの --ai を付けます。
SdiCli.exe mapping exe --id M001 --ai --request-id AI-RUN-001 --format json
AIモードの設定変更・直接実行は単一Worker構成に対応し、Studio終了・Worker停止を確認してから行います。CLIは強制終了しません。Workerでスケジュールを検証している間は、CLIでは状態・履歴の参照を行います。手動・AIともにCLIの変更・実行は排他制御されます。
system inspectの data.license にEdition、valid、status、aiUsePermittedを表示します。規約上のAI利用条件は有効なDeveloper/Enterpriseです。ライセンス取得不能時にDeveloperとみなすことはありません。CLI自身がEdition別にコマンドを拒否する仕組みではないため、ライセンス条件も確認してください。
設定生成・AI操作の対応範囲
| 項目 | 対応範囲 |
|---|---|
| 接続・メタデータ | ローカルOracle 12c以降、PostgreSQL 12以降。新規ConnectionはBasic接続。 |
| Mapping生成 | Table抽出、全件・フィルタ・日時差分、Append/Merge、削除+Appendによる洗替。 |
| Scheduler生成 | Hourly/Daily/Weekly/Monthly/Repeat。 |
| 対象外 | 任意の変換式やAPI入力マッピングの生成、CustomSQL、上記以外のDBに対する設定生成・AI操作、クラスタ変更、Worker起動・停止、汎用ドライラン、実行中断。 |
この表はCLIで設定を生成する操作と、--aiを指定した操作の対応範囲です。手動で保存済みマッピングを実行する方法は、保存したマッピングを実行するを参照してください。
Mapping IDの確認方法
ホーム画面のマッピング一覧で詳細アイコンをクリックし、詳細画面のMapping IDを確認します。mapping list でも確認できます。


設定の初期化と管理キー
管理キーを作成・変更する前に、CLI実行を停止し全処理の終了を確認してください。設定が見つからない、またはキーを読めない場合は、システム設定の復旧手順を確認してください。