フォーム
フォームは、アクションのパラメーターの値を入力し実行できる画面を作成するためのコンポーネントです。ビューの利用者は、必要に応じてパラメーターの値を入力し、実行ボタンを押すことでアクションを実行できます。
アクションの実行結果は「テーブル」「詳細テーブル」から利用できます。 詳しい利用方法についてはそれぞれのドキュメントをご参照ください。
アクション設定
ビューの利用者が実行するアクションを選択します。
選択できないアクション
以下の条件に該当するアクションは選択できません。
- 非推奨の「システム値」パラメーターを持つ
- データソースが削除されている
- ジョブキューが設定されている（⚠️限定公開の機能です）
パラメーターの初期値
パラメーターを持つアクションを選択すると、アクションのパラメーターの初期値を入力できます。 入力した初期値は、ビューを開いたときに自動的にフォームの各要素に入力される値です。 ビューの利用者は初期値のままでもアクションを実行できますし、編集してからの実行も可能です。
ファイルパラメーターに対しては初期値を設定できません。
入力方法
パラメーターの初期値は、アクション実行画面と同じフォームでの入力が可能です。利用できるフォームについては、各種パラメーターをご覧ください。
また、「値を式で設定する」を有効にすると、JavaScriptを使って柔軟に値を設定できます。詳細については「式」をご覧ください。
なお、式では以下の値が使用できます。値の詳しい説明についてはドキュメントの各セクションをご覧ください。
resultsは「初期値用アクション」を設定すると利用可能になります。
フォームに表示しない
パラメーターごとに「フォームに表示しない」チェックボックスを設定できます。 このチェックボックスを有効にすると、ビューの利用者にはそのパラメーターの入力欄が表示されなくなり、設定した初期値が自動的に使用されます。
たとえば、データの更新フォームを作成する場合に、更新対象のレコードIDをURLのクエリパラメーターから受け取るケースを考えます。
IDパラメーターの初期値を「値を式で設定する」で urlQueries.id のように設定し、「フォームに表示しない」を有効にします。
これにより、ビューの利用者にはIDの入力欄が表示されず、URLから自動的にIDが設定された状態でアクションを実行できます。
フォームの表示時に初期値で実行する
「フォームの表示時に初期値で実行する」オプションを有効にすると、フォームコンポーネントの表示時に初期値を使ってアクションを自動実行します。
このオプションは例えば、開いたときには全件を表示しその後絞り込みを行なえる検索画面を作るようなケースでご活用いただけます。実行結果は「フォームで実行」を設定している「テーブル」や「詳細テーブル」で表示されます。
ビューからフォームを手動で実行すると、新しい結果で上書きされます。
ファイルパラメーターを持つアクションでは、ファイルに初期値を設定できないため、このオプションを有効にしても表示時の自動実行はスキップされます。
レビュー設定が有効なアクションでは、このオプションは使用できません。
初期値用アクション
初期値用アクションはフォームの初期値にアクションの実行結果を設定できる機能で、データを更新する画面などを作る際に使用できます。
選択できないアクション
以下の条件に該当するアクションは選択できません。
- ファイルパラメーターを持つ
- 非推奨の「システム値」パラメーターを持つ
- データソースが削除されている
- ジョブキューが設定されている（⚠️限定公開の機能です）
パラメーターの値
パラメーターを持つ初期値用アクションを実行するために、パラメーターの値を入力する必要があります。 初期値用アクションはビューが表示されたときに自動で実行されます。 入力した初期値用アクションのパラメーターの値はその際に使用され、ビューの利用者からは見えません。
入力方法
入力方法は「アクション設定」のパラメーターの初期値と同様です。ただし、「値を式で設定する」において初期値用アクションの結果を使うことはできません。
レビュー設定が有効なアクション
レビュー設定が紐づいているアクションをフォームに設定すると、ビューの利用者はアクションを直接実行する代わりにレビュー依頼ができます。
アクション選択時の表示
レビュー設定が紐づいているアクションは、アクション選択のドロップダウンリストで「（レビュー設定あり）」というラベルが表示されます。
レビューが有効な環境の確認
レビュー設定が紐づいているアクションを選択すると、設定画面に「レビューが有効な環境」が表示されます。ここでは、どの環境でレビューが必要になるかを確認できます。
ビュー利用者の操作
レビューが有効な環境でビューを開くと、通常の「実行する」ボタンの代わりに「レビューを依頼する」ボタンが表示されます。ビューの利用者は、パラメーターの値を入力した後にレビュー依頼を作成できます。
レビュー依頼の詳細については「レビュー設定」をご覧ください。
実行後の動作
フォームコンポーネントの実行が成功したときに、指定した別の画面へ自動で移動する設定です。移動先には、フォームの実行結果などを引き継いで渡すことができます。
たとえば、レコードの登録フォームで登録が成功した後に、作成されたレコードの詳細を表示するビューへ自動で移動できます。このとき、作成されたレコードのIDを移動先へ引き継げます。
画面移動を設定した場合、実行結果は移動先の画面で扱います。そのため、結果を表示するための「テーブル」「詳細テーブル」を同じビューに配置する必要はありません。
設定方法
フォームコンポーネントの設定画面にある「実行後の動作」タブを開き、「実行成功時に別の画面へ移動する」を有効にします。続けて、移動先として「ビュー」または「アクション」を選択します。
この設定を有効にしない限り、フォームの挙動は変わりません。
移動先がビューの場合
移動先のビューを選択し、必要に応じて移動先へ渡すクエリパラメーターを設定します。
- 移動先のビューにクエリパラメーター設定がある場合は、各クエリパラメーターの値を入力できます。
- それ以外のビューでは、「クエリパラメーターを追加」から渡したいクエリパラメーターの名前と値を追加できます。
各クエリパラメーターの値は、「値を式で設定する」を有効にすると式（JavaScript）で動的に設定できます。たとえば、値の式に results[0].success.data.id と設定すると、フォームの実行結果からIDを取り出して移動先のクエリパラメーターに渡せます。
移動先がアクションの場合
移動先のアクションを選択し、必要に応じてパラメーターの初期値を設定します。
- パラメーターの初期値は、「値を式で設定する」を有効にすると式（JavaScript）で設定できます。
- 「移動時に自動でアクションを実行する」を有効にすると、移動先のアクション実行画面を開いた時点で、設定した初期値を使ってアクションを自動的に実行します。
式で使用できる値
クエリパラメーターやパラメーターの初期値を式で設定する場合、以下の値を参照できます。値の詳しい説明については「式」をご覧ください。
results: フォームの実行結果。アクションの実行結果は複数になる場合があるため配列形式です（例：results[0].success.data.id）。urlQueries: 現在のビューのクエリパラメーターの値。vars: 変数・シークレットで設定した変数の値。
移動するタイミングと制約
- 移動するのは、ビューの利用者がフォームからアクションを実行し、成功したときのみです。
- 「フォームの表示時に初期値で実行する」による表示時の自動実行では移動しません。
- レビュー設定が有効なアクションは、この機能の対象外です。
- 移動先のビュー・アクションが削除されている場合や、式の評価でエラーが発生した場合は、移動せずにエラーメッセージを表示します。この場合もアクションの実行自体は成功しています。
エディターのプレビューでの挙動
ビジュアルエディターのプレビューでは、実際には移動しません。移動するとエディターの編集内容が失われるため、フォームの実行が成功した後に「移動先を新しいタブで開く」リンクを表示します。設定にエラーがある場合は、その内容をプレビュー上に表示します。