# 引数リファレンス

以下の表に、カテゴリ別にグループ化された利用可能なすべての引数を一覧表示します。

情報メモ

ユーザーインターフェースは、一部の設定に異なるデフォルトを適用します。ウィザードはデフォルトで、固定キャンバスモード、リロード有効、および自動バイナリ有効に設定されています。CLIはデフォルトで動的グリッドモード、リロード無効、および自動バイナリ無効に設定されています。ウィザードからCLIに移行する際は、ウィザードの動作に合わせるため、これらのフラグを明示的に指定してください。

## 入力および出力

| 引数 | 説明 | 初期設定 |
| --- | --- | --- |
| `--prjPath PATH` | QV PRJ フォルダーまたはZIPファイルへのパス。PRJ zipアーカイブも受け入れます。 | — |
| `--qvw PATH` | QVWまたはQVFファイルへのパス。シングルプロジェクトモードで必須です。 | — |
| `--generatePrj` | 変換前にQVWファイルからPRJフォルダーを自動生成する | オフ |
| `--outputDir FOLDER` | 出力ルートディレクトリ。QV2QS は、プロジェクト名と同じ名前のサブフォルダーを自動的に作成します。必須。 | — |

## バッチモード

| 引数 | 説明 | 初期設定 |
| --- | --- | --- |
| `--batchDir FOLDER` | QVWとPRJのペアについて、1つ以上のフォルダーを再帰的にスキャンします。複数のフォルダーを`;`で区切ります。 | — |
| `--batchWorkers N` | 最大同時実行変換数 (`0` = 自動: CPUコア数マイナス1) | `0` |
| `--batchFlatOutput` | ソースフォルダーの階層を保持する代わりに、すべての出力を`--outputDir`の直下に書き込みます | オフ |

## Qlik Cloud

| 引数 | 説明 | 初期設定 |
| --- | --- | --- |
| `--unbuildOnly` | ローカルのみモード。Qlik Cloud に接続せずに、ビルド出力および変換レポートをディスクに生成します。評価、レビュー、オフラインでの使用を目的としています。ローカル出力には、メディアのアップロード、バックグラウンドの解決、代替状態の作成、またはシートの公開は含まれません。詳細については、[変換の仕組み](https://help.qlik.com/ja-JP/migration/Content/Qv2qsMigration/getting-started/how-conversion-works.htm#local-only-mode)をご覧ください。 | オフ |
| `--qsAppName NAME` | Qlik Cloud 内の Qlik Sense アプリの名前 | QVWファイル名、PRJフォルダー名、または出力フォルダー名 |
| `--appId APP_ID` | 新しいQlik Cloudアプリを作成するのではなく、既存のQlik Cloudアプリを更新します | — |
| `--appIdFile PATH` | ファイルからアプリIDを読み込む | — |
| `--reuseAppId` | 既存のファイルがある場合、`cloud/cloud_state.json` のアプリ ID を再利用します。 | オフ |
| `--preserveTargetAppScript` | ターゲットのアプリで既存のロード スクリプトを保持してください。変換されたロード スクリプトは適用されません。`--appId` または `--reuseAppId` が必要です。`--reload` と組み合わせることで、既存のスクリプトを実行できます。 | オフ |
| `--preserveTargetAppVariables` | 対象アプリで既存の変数を維持します。変換された変数が適用されていません。`--appId` または `--reuseAppId` が必要です。 | オフ |
| `--noBackup` | 既存のアプリを再利用する際は、自動の展開前バックアップをスキップします。既定では、QV2QS は、アプリを変更する前に、データなしの QVF を `cloud/backups/` にエクスポートします。 | オフ |
| `--reload` | ロード スクリプトを実行するために、ビルド後にアプリを再読み込みします | オフ |
| `--autoBinary` | QVW/QVF をバイナリ ロードのために Qlik Cloud にアップロードし、リロード後に削除します。`--reload`が必要です。シングルプロジェクトモードでは、`--qvw`も必要です。バッチモードでは、QVWファイルが自動的に検出されます。`--binaryAppId`と相互排他的です。 | オフ |
| `--binaryAppId APP_ID` | アップロードする代わりに、Qlik Cloudの既存のアプリをバイナリ ロードに使用します。`--autoBinary`と相互排他的です。 | — |
| `--noPublishSheets` | ビルド後にシートを公開しないでください。既定では、QV2QS は変換されたすべてのシートをベースシートとして公開し、すべてのアプリユーザーがそれらを表示できるようにします。このフラグを使用すると、シートを個人用（未公開）オブジェクトとして保持できます。既存のアプリを再利用する場合 (`--reuseAppId` または `--appId`)、以前に公開されたシートは自動的に復元されます。このフラグは、現在の変換で追加された新しいシートにのみ適用されます。 | オフ |
| `--noData` | データなしでビルド | オフ |
| `--exportQvf` | アプリをQVFファイルとしてエクスポートし、その後、クラウドアプリを削除します | オフ |
| `--exportQvfNoData` | QVFをデータなしでエクスポートします。`--exportQvf`が必要です。 | オフ |
| `--mediaUploadWorkers N` | 並列メディアアップロードスレッド | `2` |
| `--buildConfig PATH` | ビルド構成マニフェストが `qlik app build` に渡されました。QV2QS は変換中にこのファイルを自動生成します。カスタムマニフェストを指定する場合にのみ上書きします。 | `config.yml` |
| `--spaceId SPACE_ID` | アプリ作成用の対象Qlik Cloudスペース | 個人スペース |

## 認証

| 引数 | 説明 | 初期設定 |
| --- | --- | --- |
| `--qlikContext NAME` | qlik-cli 認証用コンテキスト名 | — |
| `--qlikTenantUrl URL` | テナント URL (`https://<tenant>.<region>.qlikcloud.com`)。`--qlikApiKey` と組み合わせると、qlik-cliコンテキストを作成せずに直接認証します。 | — |
| `--qlikApiKey KEY` | 認証用のAPIキー。`--qlikTenantUrl` と組み合わせると、qlik-cli コンテキストを作成せずに直接認証します。キーはディスクに書き込まれません。 | — |
| `--qlikCliPath PATH` | qlik-cli実行可能ファイルへのパス | 同梱 |
| `--qlikContextsFile PATH` | qlik-cli コンテキストファイルの場所の上書き | — |
| `--qlikNoPrompt` | 認証情報がない場合、終了コード1で直ちに失敗します。インタラクティブなプロンプトなし。CI/CDパイプラインに適しています。 | オフ |
| `--setupQlikAuth` | Qlik Cloud 認証を設定して終了します。`--qlikTenantUrl`と`--qlikApiKey`の両方が提供されている場合は不要です。 | — |

## レイアウトとスタイリング

固定キャンバスと動的グリッドモードの詳細については、[変換レイアウト設定](https://help.qlik.com/ja-JP/migration/Content/Qv2qsMigration/conversion-layout-settings/index.htm)を参照してください。

| 引数 | 説明 | 初期設定 |
| --- | --- | --- |
| `--fixedSheetCanvas` | 固定サイズのピクセルキャンバスシートを有効にする (QlikViewスタイルの配置) | オフ |
| `--fixedSheetCanvasScale FACTOR` | この係数でキャンバスの寸法を拡大/縮小します | `1.4` |
| `--fixedSheetCanvasObjectScale FACTOR` | オブジェクトの位置とサイズをこの倍率でスケールします | `1.4` |
| `--fixedSheetCanvasMinWidthPx PX` | 最小キャンバス幅 (ピクセル) | `1200` |
| `--fixedSheetCanvasMinHeightPx PX` | 最小キャンバスの高さ (ピクセル単位) | `700` |
| `--perSheetCanvasSize` | 均一なサイズ設定ではなく、シートごとのキャンバス寸法を使用する | オフ |
| `--noAutoExtendDynamicSheet` | 動的モードでのシートの高さの自動拡張を無効にする | オフ |
| `--layoutShrinkX STEPS` | レイアウトコンテナの幅をNグリッドステップ分 (0～23) 縮小する | `0` |
| `--layoutShrinkY STEPS` | レイアウトコンテナの高さをN グリッドステップ (0～11) 縮小する | `0` |
| `--cropCanvasWidth PX` | キャンバスをピクセル単位で正確な幅に切り抜きます。固定キャンバスモードのみ。`--cropCanvasHeight`と合わせて指定する必要があります。`--perSheetCanvasSize`と相互排他的です。 | `0` |
| `--cropCanvasHeight PX` | キャンバスをピクセル単位で正確な高さにトリミングします。固定キャンバスモードのみ。`--cropCanvasWidth`と合わせて指定する必要があります。`--perSheetCanvasSize`と相互排他的です。 | `0` |
| `--maxCanvasWidth PX` | キャンバスの最大幅 (ピクセル単位)。`0` を設定すると、制限が無効になります。固定キャンバスモードのみ。 | `0` |
| `--maxCanvasHeight PX` | キャンバスの最大高さ（ピクセル単位）。`0` は制限を無効にします。固定キャンバスモードのみ。 | `0` |
| `--appTheme THEME` | 変換されたアプリに Qlik Sense アプリ テーマが適用されました。任意の組み込みテーマ識別子 (`sense`, `horizon`, `breeze`, `card`) またはテナントにインストールされているカスタムテーマ名を受け入れます。Sense Classic (`sense`) は、最も目立たないテーマであり、QlikViewとの1:1の忠実度が最も高くなります。非クラシックテーマでは、オブジェクトの境界線、背景色、フォント、およびパディングが変更される場合があります。テーマは既定値のみを設定します。ユーザーはQlik Senseクライアントでいつでもテーマを切り替えることができます。 | `sense` |
| `--disableSheetBackgrounds` | シートの背景画像の抽出をスキップ | オフ |
| `--noDocBgFallback` | 背景が設定されていないシートには、文書の背景を適用しないでください。 | オフ |
| `--sheetBackgroundColor COLOR` | すべてのシートに単色塗りつぶし (`#RRGGBB`、`#RRGGBB@0.5`、または`transparent`) | — |
| `--showSheetHeader` | シートヘッダー領域を表示 | オフ |
| `--skipHiddenSheets` | 表示条件が常にfalseのシートを除外する | オフ |

## コンバージョンレポート

コンソールレポートとExcelレポートは、CLIモードとユーザーインターフェースの両方で、デフォルトで有効になっています。

| 引数 | 説明 | 初期設定 |
| --- | --- | --- |
| `--report` | コンソール変換レポートを有効にする | オン |
| `--noReport` | コンソール変換レポートを無効にする | — |
| `--reportXlsx [PATH]` | レポートをExcelファイルとしてエクスポートします。ファイル名を受け入れます (例:`MyReport`) または完全なパス。`.xlsx` は自動的に追加されます。相対名は`outputDir/reports/`に配置されます。自動命名のためにパスを省略する。 | 設定される |
| `--noReportXlsx` | Excel エクスポートを無効にする | — |
| `--reportIncludeBuiltIns` | 現在の選択と検索オブジェクトをレポートに含める | オフ |

## コンソールとロギング

| 引数 | 説明 | 初期設定 |
| --- | --- | --- |
| `--console {pretty,plain,silent,ui}` | コンソール出力モード | `pretty` |
| `--dark` | ダーク コンソール テーマ | オン |
| `--light` | ライト コンソール テーマ | オフ |
| `--surface` | コンソールの背景の塗りつぶしを有効にする | オン (プリティモードで) |
| `--noSurface` | 背景の塗りつぶしを無効にする | — |
| `--plain` | `--console plain` のショートカット | — |
| `--silent` | `--console silent` のショートカット | — |
| `--logLevel LEVEL` | ログの詳細度: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` | `INFO` |
| `--logDir FOLDER` | ログ出力フォルダーを上書きする | `%LOCALAPPDATA%\QV2QS\logs\` (単一プロジェクト) または `<outputDir>/logs/` (バッチ) |
| `--cleanLogs` | 実行前に30日以上前のログファイルを削除する | オフ |

QV2QSは4つのコンソール出力モードをサポートしています。

* 見栄えの良い — 色、アニメーションスピナー、プログレスバー、テーマ付きパネルを備えたリッチフォーマット出力。プリティモードは、対話型ターミナルで使用する際のデフォルトです。カラー対応ターミナルが必要です (Windows 10以降、PowerShell 5以降、またはUnix系シェル)。
* プレーン — タイムスタンプ付きテキスト出力（ANSIエスケープコードなし）。各行の先頭には、経過時間スタンプとフェーズタグが、`[MM:SS] [phase] message` の形式で付加されます。ヘッダーとテーブルはASCII文字を使用します。CI/CDパイプライン、ログファイル、およびANSIフォーマットをサポートしないターミナルに適しています。
* 静音 — すべての標準出力を抑制します。エラーのみが表示されます。コンソール出力が不要な自動バッチ処理やスクリプト化されたワークフローに適しています。
* UI — タイムスタンプやANSIコードを含まない行指向の出力。ユーザーインターフェースは、変換サブプロセスを起動する際に、このモードを自動的に設定します。形式は、組み込みのログ ビューアに最適化されています。ターミナルから`--console ui`を実行すると、読み取り可能ですがフォーマットされていない出力が生成されます。ターミナルで直接使用する場合は、代わりに`--plain`または`--console pretty`を使用してください。

`--dark` および `--light` フラグはカラーテーマを選択します。ダークテーマ (既定) は、ディープネイビーのQlikにインスパイアされたパレットを使用しています。ライトテーマはライトグレーのパレットを使用します。`--surface`フラグを有効にすると、各出力行の背後に微妙な背景の塗りつぶしが表示されます。サーフェス塗りつぶしは、プリティモードで既定で有効になっています。背景の塗りつぶしを無効にするには、`--noSurface`を使用します。

シングルプロジェクトモードでは、ログファイルはデフォルトで`%LOCALAPPDATA%\QV2QS\logs\`に書き込まれます。バッチモードでは、ログファイルは出力ディレクトリ内の`logs/`サブフォルダーに書き込まれます。場所を`--logDir`で上書きします。変換の問題のトラブルシューティングのために、詳細な診断出力をキャプチャするように `--logLevel DEBUG` を設定します。各実行前に、30日以上前のログファイルを削除するには、`--cleanLogs`を使用します。ログファイルの場所、ローテーション、形式の詳細については、[ログと診断](https://help.qlik.com/ja-JP/migration/Content/Qv2qsMigration/command-line-interface/logging-and-diagnostics.htm)を参照してください。

## スクリプトを読み込み

| 引数 | 説明 | 初期設定 |
| --- | --- | --- |
| `--scriptReplacements PATH` | スクリプト置換ルールのJSONファイル提供された場合、ファイル内のルールのみが実行されます。組み込みのデフォルトは自動的に読み込まれません。以下の形式を参照してください。 | — |
| `--noScriptReplacements` | すべてのスクリプトの置換を無効にする。ファイルの有無にかかわらず、ルールは実行されません。 | オフ |

既定では、QV2QS は、Qlik Cloud の互換性のために、Windows のバックスラッシュパスをフォワードスラッシュに正規化する 8 つの組み込みルールを適用します。次の表に、組み込みルールを一覧表示します。

| ID | 説明 | ターゲット |
| --- | --- | --- |
| 1 | `lib://`パス内のバックスラッシュを正規化する | `lib://DataFiles\subfolder\file.qvd` |
| 2 | `STORE...INTO`パス内のバックスラッシュを正規化する | `STORE table INTO 'C:\data\file.qvd'` |
| 3 | `FROM` パス内のバックスラッシュを正規化 (引用符付き) | `FROM 'C:\data\file.qvd'` |
| 4 | `LET` ステートメントパス内のバックスラッシュを正規化する | `LET vPath = 'C:\data\files';` |
| 5 | `SET` ステートメントパス内のバックスラッシュを正規化する | `SET vPath = 'C:\data\files';` |
| 6 | `BINARY` ステートメントパス内のバックスラッシュを正規化する | `BINARY 'C:\apps\source.qvw'` |
| 7 | バックスラッシュを正規化する`FROM`パス (引用符なし) | `FROM C:\data\file.qvd` |
| 8 | `$(Variable=path)` 展開におけるバックスラッシュを正規化する | `$(Must_Includes=C:\lib\file.qvs)` |

各ルールは2段階のマッチングプロセスを使用します。`pattern` フィールドは、ロード スクリプトの領域を選択する正規表現です。`search`フィールドは、その後、一致した各領域内でのみ適用されます。このアプローチにより、対象となるコンテキスト外での意図しない置換が防止されます。

`--scriptReplacements`引数は、すべての置換ルールに対する唯一の信頼できる情報源となるJSONファイルを受け入れます。ファイルが提供されると、組み込みの既定値は自動的に読み込まれません。組み込みルールをカスタムルールと合わせて含めるには、ウィザードから完全なルールセットをエクスポートし、エクスポートしたファイルを編集します。ルールは`execution_order`の順序で実行されます。

3つのCLI動作が利用可能です:

* フラグなし — 8つの組み込みルールが実行されます。
* `--scriptReplacements <file>` — ファイル内のルールのみが実行されます。組み込みのデフォルトは自動的に読み込まれません。
* `--noScriptReplacements` — ルールは実行されません。

ヒント メモ

カスタムルールファイルを作成するには、ウィザードを開き、スクリプトの置換セクションでエクスポートをクリックし、エクスポートされたJSONを開始点として使用します。エクスポートされたファイルには、8つの組み込みルールすべてが正しい形式で含まれています。必要に応じてルールを追加、削除、または変更し、その後`--scriptReplacements` を使用してファイルを渡します。

`--scriptReplacements`ファイルはルールオブジェクトのJSON配列です。

```
[
  {
    "description": "Replace server path with lib connection",
    "pattern": "FROM\\s+'[^']*'",
    "search": "\\\\\\\\server\\\\share\\\\",
    "replace": "lib://DataFiles/",
    "is_regex": true,
    "case_sensitive": false,
    "enabled": true,
    "execution_order": 1
  }
]
```

各ルールには次のフィールドがあります。

| フィールド | 説明 | 必須 |
| --- | --- | --- |
| `description` | ルールの人間が判読できるラベル | 可 |
| `pattern` | スクリプトの検査対象領域を選択する正規表現 | 可 |
| `search` | 一致した各領域内で検索するテキストまたは正規表現 | 可 |
| `replace` | 置換テキスト | なし (既定値: 空の文字列。一致したテキストを削除します) |
| `is_regex` | `search`が正規表現（`true`）か、リテラル文字列（`false`）か | なし (既定: `true`) |
| `case_sensitive` | マッチングで大文字と小文字を区別するかどうか | なし (既定: `false`) |
| `enabled` | ルールがアクティブであるかどうか | なし (既定: `true`) |
| `id` | UIトラッキング用の数値識別子 | 不可 |
| `execution_order` | 実行順序を制御する数値。値が低いほど最初に実行されます。 | なし (既定: `0`) |

情報メモ

このファイルは、ウィザードからエクスポートされたファイルとの互換性のために、camelCaseのフィールド名 (`isRegex`, `caseSensitive`, `executionOrder`) も受け入れます。

## その他

| 引数 | 説明 | 初期設定 |
| --- | --- | --- |
| `--listboxBackgroundExpr EXPR` | リストボックスの背景色。`dynamic` QVの色を保持します。`#RRGGBB`、`#AARRGGBB`、`rgb(r,g,b)`、または`argb(a,r,g,b)`も受け入れます。 | `dynamic` |
| `--disableDateStateStickySort` | 日付フィールドのソートガードを無効にする。以下の「」を参照してください。 | オフ |
| `--fixSingleQuotedSearch` / `--noFixSingleQuotedSearch` | セット分析で、単一引用符のワイルドカードと比較を二重引用符に変換します。以下の「」を参照してください。 | オン |
| `--fixUnquotedSetValues` / `--noFixUnquotedSetValues` | 実験的。セット分析で、引用符なしの裸の文字列値を単一引用符で囲みます。以下の「」を参照してください。 | オフ |
| `--ui` | 変換を実行するのではなく、ユーザーインターフェースを起動します | オフ |
| `--port PORT` | ユーザーインターフェースポート | 設定される |
| `--noBrowser` | UI起動時にブラウザを自動的に開かない | オフ |
| `--version` | バージョンを表示して終了 | — |
| `--accept-eula` | インタラクティブなプロンプトなしでエンドユーザーライセンス契約に同意します。CI/CDパイプラインおよび自動化されたワークフロー向けです。 | オフ |

### 日付フィールド ソートガード

既定では、Qlik Sense は選択された値をリストボックスの先頭に並べ替えます。四半期、月、年などの日付のようなフィールドの場合、この並べ替えによって期待される時系列が崩れてしまいます。QV2QS は、日付のようなフィールド名を検出するためのヒューリスティックを適用し、それらのフィールドでの状態ベースのソートを抑制することで、選択状態に関係なく値を自然な順序に保ちます。

ヒューリスティックは、英数字以外の文字とキャメルケースの境界で分割することにより、各フィールド名をトークン化します (例えば、`OrderDate` は `order` と `date` になります)。すべてのトークンは小文字です。フィールドが一致するのは、いずれかのトークンが次のいずれかに等しい場合です。`date`, `dates`, `month`, `months`, `year`, `years`, `quarter`, `quarters`, `qtr`, `qtrs`, `week`, `weeks`, `day`, `days`, `fiscal`, `fy`, `period`, `calendar`。フィールドは、いずれかのトークンが`date`、`month`、または`year`で終わる場合にも一致します (例えば、`OrderDate`、`FiscalMonth`)。トークン`update`、`candidate`、および`validate`は、誤検知を避けるために除外されます。照合は、大文字と小文字を区別せず、英語のトークンのみを使用します。英語以外のフィールド名 (例えば、`Monat` または `Fecha`) は検出されません。

ヒューリスティックに一致するフィールドでは、状態ベースの並べ替えが削除され、自動並べ替えが無効になります。

`--disableDateStateStickySort` を使用して、このヒューリスティックをオフにします。無効にすると、すべてのリストボックスフィールドは、状態ベースの並べ替えを含め、デフォルトのQlik Senseソート動作を使用します。

### セット分析のクォーテーション修正

QlikView と Qlik Sense では、セット分析修飾子における引用符の解釈が異なります。QV2QS は変換中に2つの独立した修正を適用します。単一引用符検索の修正は、既定で有効になっています。引用符なしのセット値の修正は試験段階であり、デフォルトでは無効になっています。

シングルクォートされた検索値の修正 (`--fixSingleQuotedSearch`)

検索構文を含むシングルクォートの値は、ダブルクォートに変換されます。検出された検索パターンには、ワイルドカード (`*`, `?`, `^`)、比較演算子 (`>`, `>=`, `<`, `<=`)、あいまい検索 (`~`)、式検索 (`=`)、検索修飾子 (`+`, `-`)、および複合検索 (`(…|…)`, `(…&…)`) が含まれます:

* `{<Year={'2*'}>}` になります `{<Year={"2*"}>}`
* `{<Amount={'>100'}>}` になります `{<Amount={">100"}>}`
* `{<Customer={'~company'}>}` になります `{<Customer={"~company"}>}`

シングルクォートで囲まれたプレーンテキストリテラル (例: `'USA'`) および数値フィールドのシングルクォートで囲まれた値は影響を受けません。この修正を無効にするには、`--noFixSingleQuotedSearch`を使用します。

引用符で囲まれていない設定値を修正 (`--fixUnquotedSetValues`) — *試験段階*

引用符なしの裸の文字列値は単一引用符で囲まれます:

* `{<Country={USA}>}` になります `{<Country={'USA'}>}`

数値 (`2024`)、ドル記号変数 (`$(vYear)`)、および二重引用符で囲まれた文字列は変更されません。この修正はデフォルトで無効になっています。`--fixUnquotedSetValues`を渡して有効にします。`--noFixUnquotedSetValues` を使用して明示的に無効にします。

両方の修正は、軸とメジャー式にのみ適用されます。サポートされていない機能の検出結果は変更されません。修正が無効になっている場合、フラグが付けられたパターンは、Expression\_Findings ワークシートで手動レビュー用に残ります。

## 詳細はこちら

* [一般的なワークフロー](https://help.qlik.com/ja-JP/migration/Content/Qv2qsMigration/command-line-interface/common-workflows.htm)
* [ロギングおよび診断](https://help.qlik.com/ja-JP/migration/Content/Qv2qsMigration/command-line-interface/logging-and-diagnostics.htm)
* [レイアウトモード](https://help.qlik.com/ja-JP/migration/Content/Qv2qsMigration/conversion-layout-settings/index.htm)