外部からの入力(POSTリクエスト)を契機として、Experience Cloudでの申請を開始する機能です。
もくじ
設定方法
前提条件
Experience Cloud上にcommonInputPageを使用した申請ページを構築済みであることを前提とします。
カスタムメタデータの設定
外部入力
カスタムメタデータ型「外部入力」(External Entry)のレコード"Setting"の項目を編集します。
※"Setting"はカミレスに含まれているため、新規作成する必要はありません。
Experience CloudのURL
Experience Cloud上に構築した申請画面のURLを入力します。
Experience Cloudのテンプレートタイプ
Experience Cloud作成時に選択したテンプレートのタイプ(Aura/LWR)を選択します。
ブラウザのストレージのキー
基本的に変更する必要はありません。
複合鍵
後述する外部入力パラメーターの設定で、「暗号化およびBase64エンコードされている」を有効にする場合は入力が必要です。復号に用いる鍵の文字列を入力します。
ハッシュ値の元となる値の形式
後述する外部入力パラメーターの設定で、「ハッシュ値と見なす」を有効にする場合は入力が必要です。ここで入力された形式をハッシュ値生成のキーとします。
"{parameterName}"と入力した部分は、ハッシュ値の生成前に、名前が"parameterName"であるパラメーターの値に置換されます。
例: パラメータa, b, c, d, eの値を連結したものをハッシュキーにする場合は、"{a}{b}{c}{d}{e}"
外部入力パラメーター
カスタムメタデータ型「外部入力パラメーター」(External Entry Parameter)のレコードを、リクエストに使用するパラメータの種類数分、新規作成します。
「帳票名と見なす」が有効のデータを必ず１つ作成します。
表示ラベル
パラメータの意味がわかるような任意の名前を入力します。
内部処理では使用されません。
外部入力パラメーター名
リクエストするパラメータ名を入力します。
API および管理パッケージで使用される一意の名前です。名前には英数字とアンダースコアのみを使用し、先頭は英字にする必要があります。名前の最後にアンダースコアは使用できません。また、アンダースコアを連続して使用することもできません。
外部入力
入力欄の右側にある虫眼鏡アイコンをクリックし、"Setting"を選択します。
暗号化およびBase64エンコードされている
このパラメータの値をBase64デコードおよび復号する必要がある場合は有効にします。
暗号のアルゴリズムはAES256で固定となります。
ハッシュ値と見なす
このパラメータの値を、リクエストの正しさを検証するためのハッシュ値として使う場合は有効にします。
「ハッシュ値と見なす」がオンであるパラメータが存在する場合、リクエスト時にその値と外部入力設定の「ハッシュ値の元となる値の形式」を元に生成したハッシュ値を照合します。一致しない場合はエラーとなります。
「ハッシュ値と見なす」パラメータの値は、16進数変換した文字列とする必要があります。また、ハッシュ値生成のアルゴリズムはSHA-256で固定となっています。
有効期限と見なす
パラメータの値をリクエストの有効期限として使う場合に有効にします。
「有効期限と見なす」が有効であるパラメータが存在する場合、リクエスト時にその値と処理時刻を照合します。処理時刻がその値を過ぎている場合はエラーになります。
必須
このパラメータを必須とする場合、有効にします。
リクエスト時に「必須」のパラメータが無指定、あるいはその値が空の場合はエラーとなります。
帳票名と見なす
パラメータの値を、申請に使用するフォームテンプレートを特定するための帳票名として使う場合に有効にします。
これが有効であるパラメータを必ず1つ作成する必要があります。
複合の初期化ベクトルと見なす
パラメータの値を、復号の初期化ベクトルとして使う場合に有効にします。
「暗号化およびBase64エンコードされている」がオンであるパラメータがある場合は、これが有効であるパラメータも必ず1つ作成する必要があります。
「復号の初期化ベクトルと見なす」パラメータの値は、16進数変換した文字列とする必要があります。
ここでは、例として帳票名の他に値1、値2を登録します。
フォームテンプレートの設定
リクエスト時に送信するパラメータの値を、フォームテンプレートの入力欄のプリセット値として利用する場合は、フォームテンプレート編集画面からプリセット設定を行う必要があります。
プリセット種類は「外部入力パラメーター」とします。
以下の画像のようにパラメーターのプルダウンが表示されない場合は、外部入力パラメーターが作成できているかご確認ください。作成方法は外部入力パラメーターを参考に作成してください。
動作方法
Experience Cloudでの申請が出来る状態を前提とします。
この設定がまだの場合は以下の記事を参考にExperience Cloudサイトの作成を行ってください。
「commonInputPage」コンポーネントを配置したページのURLをコピーします。
https://energy-nosoftware-6638-dev-ed.scratch.my.site.com/guestPage/s/guest
コピーしたURLの末尾にパラメーターを追加します。
「外部入力パラメーター」で設定した外部入力パラメーター名イコール入力させる文字列といった形で追加します。このとき、帳票名と見なすに設定したパラメーターを必ず含むようにします。
下の例では、外部入力パラメーター名がkey・Value1・Value2です。このとき、大文字・小文字が設定したものと一致しているか確認してください。
?key=プリセット 外部入力パラメーター&Value1=apple&Value2=grape
URLの末尾に追記すると、帳票名のパラメーターに設定した帳票（ここでは「プリセット 外部入力パラメーター」という帳票名を例としている）の入力フォームが表示されます。
外部入力パラメーターの設定を行った入力欄に、プリセットされていることが確認できます。
帳票名になっているパラメーター以外の値の変更を行うと、入力欄にプリセットされる値が変わります。
入力フォームが表示されずに以下のエラーモーダルが表示された場合は、対象のフォームテンプレートの直接リンク可（FormTemplate__c.DirectLinkable__c）という項目が有効になっていることをご確認ください。
検証用コンポーネント「commonInpurtPageVerification」での動作の確認も可能です。