FMEリファレンス > ユーザーパラメーター
最終更新: 2022-1-6 | FME 2021.2.0.1
ユーザーパラメーターはワークスペース内の任意の場所から参照できる値を定義するもので、リーダー/ライター、トランスフォーマー等のパラメーターを設定してからワークスペースを実行できるようにしたい場合や、ワークスペースの編集時にそれらの値を変更し易くしたい場合などに有用です。
例えば、ユーザーパラメーターとして次のような値を定義することができます。
・ソース/出力先データセット名 (ファイルパス、フォルダパス等)
・読込の対象とするフィーチャータイプ名
・トランスフォーマーパラメーター
・ログの出力先ファイルパス
・座標系の識別子
公開 (Published) パラメーターと非公開 (Private) パラメーター
ユーザーパラメーターには、公開 (Published) パラメーター
と非公開 (Private) パラメーター
の2種類があり、定義済みのユーザーパラメーターは、次の図のように Navigator ウィンドウの User Parameters セクションに表示されます。
公開パラメーターを定義すると、ワークスペースの実行時にユーザーに対してそれらの値の確認や設定を求めることができ、ワークスペースのポータビリティが向上します。
リーダー/ライターをワークスペースに追加したときは、それらの Dataset とリンクする公開パラメーターが自動的に追加されます。
Workbench でワークスペースを実行した場合、Translation Log ウィンドウに表示されるコマンドラインには全ての公開パラメーターの設定内容がオプション引数として含まれるので、それを参照することによりコマンド環境への移行が容易にできます。
非公開パラメーターは、主に複数のトランスフォーマーでパラメーターの値を共有するために使われます。
例えば、スキーママッピングテーブルとして使用するデータファイルパスを値とする非公開パラメーターを作成すれば、複数の SchemaMapper トランスフォーマーでそれを同時に参照することができます。あるいは、同じデータベースの複数のテーブルにアクセスするために、データベース接続用の共通のユーザー名とパスワードのための非公開パラメーターを定義することもできます。
非公開パラメーターは、次の点で公開パラメーターと異なります。
- 実行するときに、「Prompt for User Parameters（実行前に公開パラメーターの内容を確認する）」 にチェックを入れても非公開パラメーターは確認・設定できない。
- Translation Log ウィンドウ、および *.fmw ファイルに出力されるコマンドラインのオプション引数に非公開パラメーターは含まれない。ただし、マッピングファイルにおけるマクロであるという点では公開パラメーターと同じなので、オプション引数として設定することはできる。
Navigator ウィンドウでUser ParametersをクリックしてManage User Parametersを選択し、表示されるメニューの Publishedのチェックボックスによって、そのパラメーターの公開/非公開を変更することができます。
