フォームの送信アクションエラーの処理

Version:

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

フォーム送信アクションの実行に失敗すると、送信アクションに関連付けられたデフォルトのエラーメッセージがフォームに表示され、ユーザーはフォームを送信できなくなります。送信アクションに関連付けられたデフォルトのエラーメッセージは、ニーズに合わせて変更できます。

また、送信アクションに関連付けられているデフォルトのエラーメッセージを非表示にすることもできます。これは、エラー・メッセージを表示したり、フォームの送信を防いだりしたくない場合の本番環境では重要になる場合があります。たとえば、ユーザー権限が不十分なためにxDB Trackerが使用できない場合、Trigger Goal送信アクションが失敗する可能性がありますが、この場合も、ユーザーがフォーム送信を続行できるようにする必要があります。

メモ

デフォルトのエラーメッセージは、ログファイル(App_Data\logs\log.<date>.<time>.txt)に記録されます。サブミット・アクションのError Messageフィールドがブランクの場合でも、エラー・メッセージはログ・ファイルに記録されます (例えば、ログ・エントリーはthe goal <goal item ID> cannot be registered because the Tracker is disabled or not initialized.と読み取ることができます)。さらに、一部の送信アクションは、スタックトレースを含むランタイム例外をログに記録します。

送信アクションエラーのデフォルトのエラーメッセージを変更する

この手順では、Save Dataアクションを例に、送信アクションのデフォルトのエラーメッセージを変更する方法を示します。フォームを作成すると、「データの保存」送信アクションによって、フォームのデータがFormsデータベースに保存されます。

デフォルトのエラーメッセージを変更するには:

コンテンツエディタで、/sitecore/System/Settings/Forms/Submit Actionsに移動します。
コンテンツツリーでSave Dataをクリックし、SettingsセクションのError Messageフィールドに新しいメッセージを入力して変更を保存します。

大事な

デフォルトのエラーメッセージを非表示にしてフォームの送信を許可するには、Error Messageフィールドを空白のままにします。

条件付きフォーム送信エラーメッセージの作成

より具体的なエラーメッセージが必要な場合は、カスタム送信アクションを作成して、エラーメッセージを条件付きで設定し、条件が満たされない場合はデフォルトのエラーメッセージを表示できます。

条件付きエラーメッセージを作成するには:

フォーム送信エラーメッセージをプログラムで保存アクションから変更するには、SubmitActionBaseクラスのExecuteActionメソッドをオーバーライドするカスタムのデータの保存アクションを作成します。ここでは、事前定義された送信エラーメッセージを上書きするカスタマイズされたエラーメッセージを割り当てることができます。
formSubmitContext.Errors.Add(new FormActionError { ErrorMessage = _errorMessage });

カスタムSave Data submit actionクラス内では、さまざまな条件に基づいてエラーメッセージの値を管理する必要があります。例えば：

class CustomSaveData:SaveData
    {
        private string _errorMessage;
        public CustomSaveData(ISubmitActionData submitActionData) : base(submitActionData)
        {
        }

        protected override bool SavePostedData(Guid formId, Guid sessionId, IList;IViewModel postedFields)
        {
            if (formId == Guid.Empty) //Condition 1
            {
                _errorMessage = "Invalid form id!";
                return false;
            }

            if (sessionId == Guid.Empty)// Condition 2
            {
                _errorMessage = "Invalid session!";
                return false;
            }

            try
            {
                var formEntry = new FormEntry
                {
                    Created = DateTime.UtcNow,
                    FormItemId = formId,
                    FormEntryId = sessionId,
                    Fields = new ListFieldData()
                };

                if (postedFields != null)
                {
                    foreach (var postedField in postedFields)
                    {
                        AddFieldData(postedField, formEntry);
                    }
                }
                else
                {
                    _errorMessage = "No data to save!"; //Condition 3
                    return false;
                }

                FormDataProvider.CreateEntry(formEntry);

                return true;
            }
            catch (Exception exception)
            {
                Logger.LogError(exception.Message, exception, this);
                _errorMessage = exception.Message; //Condition 4
                return false;
            }
        }

        public override void ExecuteAction(FormSubmitContext formSubmitContext, string parameters)
        {
            Assert.ArgumentNotNull(formSubmitContext, nameof(formSubmitContext));

            string data;
            if (TryParse(parameters, out data))
            {
                try
                {
                    if (Execute(data, formSubmitContext))
                    {
                        return;
                    }
                }
                catch (ArgumentNullException)
                {
                }
            }

            formSubmitContext.Errors.Add(new FormActionError
            {
                ErrorMessage = _errorMessage
            });
        }
    }

デフォルトのデータの保存アクションを置き換えるには、/sitecore/System/Settings/Forms/Submit Actionsに移動し、Save Dataをクリックし、SettingsセクションのModel Typeフィールドで、現在の値をカスタムのSave Data actionクラス名に置き換えます。

新しいサブミットアクションアイテムを作成することもできます。

この記事を改善するための提案がある場合は、お知らせください!