將規則新增至最適化表單

上次更新: 2023-12-12
  • 建立對象:
  • Beginner
    Intermediate
    User

Adobe 建議使用新式且可擴充的資料擷取核心元件,用來建立新的最適化表單將最適化表單新增到 AEM Sites 頁面。這些元件代表最適化表單建立方面的重大進步,可確保令人印象深刻的使用者體驗。本文會介紹使用基礎元件編寫最適化表單的舊方法。

版本 文章連結
AEM 6.5 按一下這裡
AEM as a Cloud Service 本文章

概觀

規則編輯器功能可讓表單業務使用者和開發人員在調適型表單物件上編寫規則。 這些規則會根據預設條件、使用者輸入及使用者對表單的動作,定義要在表單物件上觸發的動作。 它有助於進一步簡化表單填寫體驗,確保準確性和速度。

規則編輯器提供直覺式且簡化的使用者介面來撰寫規則。 規則編輯器為所有使用者提供一個視覺化編輯器。 您可使用規則對最適化表單物件執行的部分關鍵動作如下:

  • 顯示或隱藏物件
  • 啟用或禁用物件
  • 設置物件的值
  • 驗證物件的值
  • 執行函數以計算物件的值
  • 啟動表單資料模型服務並執行操作
  • 設定物件的屬性

新增至表單超級使用者群組的使用者可以建立指令碼並編輯現有指令碼。 中的使用者 forms-users 群組可以使用指令碼,但不能建立或編輯指令碼。

瞭解規則

規則是動作和條件的組合。 在 規則 編輯者 中,操作包括隱藏、顯示、啟用、禁用或計算表單中物件的值等活動。 條件是對表單物件的狀態、值或屬性執行檢查和作業來評估的Boolean運算式。 根據評估條件返回的值 ( TrueFalse ) 執行操作。

規則編輯器提供一組預先定義的規則型別(例如「何時」、「顯示」、「隱藏」、「啟用」、「停用」、「設定值」和「驗證」)來協助您編寫規則。 每種規則型別都可讓您定義規則中的條件和動作。 本檔案將詳細說明每種規則型別。

規則通常會遵循下列其中一種建構:

Condition-Action 在此建構中,規則會先定義條件,接著定義要觸發的動作。 此建構與程式設計語言中的if-then陳述式類似。

在規則編輯器中, 時間 規則型別會強制執行condition-action結構。

操作條件 在此構造中,規則首先定義要觸發的操作,然後是評估條件。 此構造的另一個變體是操作-條件-備用操作,它還定義了在條件返回 False 時要觸發的備用操作。

規則編輯器中的「顯示」、「隱藏」、「啟用」、「停用」、「設定值」和「驗證」規則型別會強制實施動作條件規則結構。 依預設,「顯示」的替代動作是「隱藏」,而「啟用」的替代動作是「停用」,反之亦然。 您無法變更預設的替代動作。

注意

可用的規則型別(包括您在規則編輯器中定義的條件和動作)也取決於您建立規則的表單物件型別。 規則編輯器僅顯示有效的規則型別和選項,用於寫入特定表單物件型別的條件和動作陳述式。 例如,您看不到面板物件的驗證、設定值、啟用和停用規則型別。

如需規則編輯器中可用規則型別的詳細資訊,請參閱 規則編輯器中的可用規則型別.

選擇規則建構的准則

雖然您可以使用任何規則建構來實現大部分的使用案例,以下提供一些選擇建構勝過其他建構的准則。 如需規則編輯器中可用規則的詳細資訊,請參閱 規則編輯器中的可用規則型別.

  • 建立規則時,經驗法則的典型做法是思考您所撰寫規則的物件內容。 假設您要根據使用者在欄位A中指定的值隱藏或顯示欄位B。在此案例中,您評估欄位A的條件,並且根據它傳回的值,觸發欄位B的動作。

    因此,如果您在欄位B (您評估條件的物件)上撰寫規則,請使用condition-action建構或When規則型別。 同樣地,使用動作條件建構或在欄位A上顯示或隱藏規則型別。

  • 有時候,您必須根據一個條件執行多個動作。 在這種情況下,建議使用條件 — 動作建構。 在此建構中,您可以評估條件一次,並指定多個動作陳述式。

    例如,若要根據條件隱藏欄位B、C和D,以檢查使用者在欄位A中指定的值,請撰寫一個具有條件 — 動作建構的規則或欄位A上的規則型別時並指定動作來控制欄位B、C和D的可見性。否則,您需要在欄位B、C和D上設定三個個別規則,每個規則會檢查條件並顯示或隱藏個別欄位。 在此範例中,在一個物件上撰寫When規則型別比在三個物件上撰寫Show或Hide規則型別更有效率。

  • 若要根據多個條件來觸發動作,建議使用動作條件建構。 例如,若要藉由評估欄位B、C和D的條件來顯示和隱藏欄位A,請在欄位A上使用顯示或隱藏規則型別。

  • 如果規則包含適用於一個條件的一個動作,請使用條件 — 動作或動作條件建構。

  • 如果規則檢查條件,並在欄位中提供值或退出欄位時立即執行動作,則建議在評估條件的欄位上編寫具有條件 — 動作建構或When規則型別的規則。

  • 當使用者變更套用When規則的物件值時,會評估When規則中的條件。 但是,如果您希望動作在伺服器端變更時觸發(例如預先填入值),建議寫入在欄位初始化時觸發動作的When規則。

  • 在撰寫下拉清單、選項按鈕或核取方塊物件的規則時,這些表單物件在表單中的選項或值會預先填入規則編輯器中。

規則編輯器中可用的運運算元型別和事件

規則編輯器提供下列邏輯運運算元和事件,您可使用它們建立規則。

  • 等於
  • 不等於
  • 開頭為
  • 結尾為
  • 包含
  • 為空
  • 不是空的
  • 已選取: 當使用者為核取方塊、下拉式清單單選按鈕選取特定選項時,傳回true。
  • 已初始化(事件): 當表單物件在瀏覽器中呈現時傳回true。
  • 已變更(事件): 當使用者變更表單物件的輸入值或選取的選項時,傳回true。
  • 導覽(事件): 當使用者按一下導覽物件時傳回true。 導覽物件用於在面板之間移動。
  • 步驟完成(事件): 規則的步驟完成時傳回true。
  • 提交成功(事件): 成功將資料提交至表單資料模型時會傳回true。
  • 提交時發生錯誤(事件): 資料提交至表單資料模型失敗時傳回true。

規則編輯器中的可用規則型別

規則編輯器提供了一組預先定義的規則型別,您可以使用這些型別來撰寫規則。 讓我們來詳細瞭解一下每種規則型別。 如需有關在規則編輯器中寫入規則的詳細資訊,請參閱 寫入規則.

時間

時間 規則型別會遵循 condition-action-alternate action 規則建構,或有時僅 condition-action 建構。 在此規則型別中,您必須先指定評估條件,接著在條件符合時觸發動作( True)。 使用When規則型別時,您可以使用多個AND和OR運運算元來建立 巢狀運算式.

使用 When 規則 類型,您可以評估表單物件的條件並對一個或多個物件執行操作。

簡而言之,典型的 When 規則 結構如下:

When on Object A:

(Condition 1 AND Condition 2 OR Condition 3) is TRUE;

Then, do the following:

關於物件B的行動2;

關於物件C的行動3;

_

當您具有多值元件(如選項按鈕或清單)時,在為該元件創建規則時,將自動檢索選項並提供給規則建立者。 您無需再次鍵入選項值。

例如,清單有四個選項:紅色、藍色、綠色和黃色。 建立規則時,會自動擷取選項(選項按鈕),以供規則建立者使用,如下所示:

多值顯示選項

撰寫When規則時,您可以觸發「清除值」動作。 清除值動作會清除指定物件的值。 在 When 語句中使用「清除值」選項可以創建具有多個欄位的複雜條件。

清除值

隱藏 隱藏指定的物件。

顯示 顯示指定的物件。

啟用 啟用指定的物件。

停用 停用指定的物件。

啟動服務 叫用表單資料模型中設定的服務。 選擇「啟動服務」作業時,會出現一個欄位。 點選欄位時,它會顯示您在上所有表單資料模型中設定的所有服務 Experience Manager 執行個體。 選擇表單資料模型服務時,會出現更多欄位,您可在其中對應具有指定服務的輸入和輸出引數的表單物件。 請參閱有關叫用表單資料模型服務的範例規則。

除了表單資料模型服務之外,您還可以指定直接的WSDL URL來叫用Web服務。 不過,表單資料模型服務有許多優點,且建議叫用服務的方法。

如需在表單資料模型中設定服務的詳細資訊,請參閱 Experience Manager Forms 資料整合.

設定值 計算並設定指定物件的值。 您可以將物件值設為字串、其他物件的值、使用數學運算式或函式的計算值、物件屬性的值,或來自已設定表單資料模型服務的輸出值。 當您選擇Web服務選項時,它會顯示在您電腦上所有表單資料模型中設定的所有服務 Experience Manager 執行個體。 選擇表單資料模型服務時,會出現更多欄位,您可在其中對應具有指定服務的輸入和輸出引數的表單物件。

如需在表單資料模型中設定服務的詳細資訊,請參閱 Experience Manager Forms 資料整合.

設定屬性 規則型別可讓您根據條件動作來設定指定物件的屬性值。 您可以將屬性設定為下列其中一項:

  • 可見(布林值)
  • dorExclusion (布林值)
  • chartType (字串)
  • 標題(字串)
  • 已啟用(布林值)
  • 強制(布林值)
  • validationsDisabled (布林值)
  • validateExpMessage (字串)
  • 值(數字、字串、日期)
  • 專案(清單)
  • 有效(布林值)
  • errorMessage (字串)

例如,它可讓您定義規則,以動態地將核取方塊新增至最適化表單。 您可以使用自訂函式、表單物件或物件屬性來定義規則。

設定屬性

若要根據自訂函式定義規則,請選取 函式輸出 ,並從以下位置拖放自訂函式: 函式 標籤。 如果符合條件動作,則自訂函式中定義的核取方塊數會新增至最適化表單。

若要根據表單物件定義規則,請選取 表單物件 從下拉式清單,將表單物件從 表單物件 標籤。 如果符合條件動作,則表單物件中定義的核取方塊數會新增至調適型表單。

根據物件屬性的「設定屬性」規則可讓您根據最適化表單中包含的其他物件屬性,新增最適化表單中的核取方塊數目。

下圖是根據最適化表單中的下拉式清單數量,以動態方式新增核取方塊的範例:

物件屬性

清除值 清除指定物件的值。

設定焦點 將焦點設定在指定的物件上。

儲存表單 儲存表單。

提交Forms 提交表單。

重設表單 重設表單。

驗證表單 驗證表單。

新增例項 新增指定之可重複面板或表格列的例項。

移除例項 移除指定之可重複面板或表格列的例項。

瀏覽至 導覽至其他 最適化Forms、影像或檔案片段等其他資產或外部URL。

設定值

設定值 規則型別可讓您根據是否滿足指定的條件來設定表單物件的值。 值可以設定為另一個物件的值、常值字串、衍生自數學運算式或函式的值、另一個物件的屬性值,或表單資料模型服務的輸出。 同樣地,您可以檢查元件、字串、屬性或衍生自函式或數學運算式的值的條件。

設定值 規則型別不適用於所有表單物件,例如面板和工具列按鈕。 標準的「設定值」規則具有以下結構:

將物件A的值設為:

(字串 ABC)或
(物件 屬性 物件 C 的 X)或
(來自函數的值)或
(值來自數學運算式)或
(資料模型服務或Web服務的輸出值);

時間(可選):

(條件 1 和條件 2 和條件 3) 為 TRUE;

以下示例將欄位中的值作為輸入,並將欄位的值 dependentid Relation 設置為表單資料模型服務的參數 getDependentRelation 輸出。

Set-value-web-service

使用表單資料模型服務設定值 規則範例

注意

此外,您可以使用規則的「設定值」,從表單資料模型服務或Web服務的輸出,填入下拉式清單元件中的所有值。 不過,請確定您選擇的輸出引數屬於陣列型別。 陣列中傳回的所有值都可在指定的下拉式清單中使用。

顯示

使用 顯示 規則型別,您可以撰寫規則來根據是否滿足條件來顯示或隱藏表單物件。 若條件未滿足或傳回,Show rule型別也會觸發Hide動作 False.

典型的Show規則結構如下:

Show Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Else:

Hide Object A;

隱藏

與顯示規則型別類似,您可以使用 隱藏 規則型別,根據是否滿足條件來顯示或隱藏表單物件。 若條件未滿足或傳回,隱藏規則型別也會觸發「顯示」動作 False.

典型的「隱藏」規則結構如下:

Hide Object A;

When:

(Condition 1 AND Condition 2 AND Condition 3) is TRUE;

Else:

Show Object A;

啟用

啟用 規則型別可讓您根據是否滿足條件來啟用或停用表單物件。 Enable規則型別也會觸發Disable動作,以防條件未滿足或傳回 False.

典型的Enable規則結構如下:

Enable Object A;

When:

(Condition 1 AND Condition 2 AND Condition 3) is TRUE;

Else:

Disable Object A;

停用

與啟用規則型別類似, 停用 規則型別可讓您根據是否滿足條件來啟用或停用表單物件。 若條件未滿足或傳回,Disable規則型別也會觸發Enable動作 False.

典型的「停用」規則結構如下:

Disable Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Else:

Enable Object A;

驗證

驗證 規則型別使用運算式驗證欄位中的值。 例如,您可以撰寫運算式來檢查指定名稱的文字方塊是否不包含特殊字元或數字。

典型的驗證規則結構如下:

Validate Object A;

Using:

(Expression 1 AND Expression 2 AND Expression 3) is TRUE;

注意

如果指定的值不符合驗證規則,您可以向使用者顯示驗證訊息。 您可以在 指令碼驗證訊息 側邊欄中元件屬性的欄位。

指令碼驗證

設定選項

設定選項 規則型別可讓您定義規則,以動態地將核取方塊新增至最適化表單。 您可以使用表單資料模型或自訂函式來定義規則。

若要根據自訂函式定義規則,請選取 函式輸出 ,並從以下位置拖放自訂函式: 函式 標籤。 自訂函式中定義的核取方塊數會新增至最適化表單。

自訂函式

若要建立自訂函式,請參閱 規則編輯器中的自訂函式.

若要根據表單資料模型定義規則:

  1. 選取 服務輸出 下拉式清單中的。
  2. 選取資料模型物件。
  3. 從中選擇資料模型物件屬性 顯示值 下拉式清單。 最適化表單中的核取方塊數目是從資料庫中為該屬性定義的例項數目衍生而來。
  4. 從中選擇資料模型物件屬性 儲存值 下拉式清單。

FDM設定選項

瞭解規則編輯器使用者介面

規則編輯器提供完整但簡單的使用者介面,用於撰寫和管理規則。 您可以在撰寫模式下,從最適化表單中啟動規則編輯器使用者介面。

若要啟動規則編輯器使用者介面:

  1. 以撰寫模式開啟最適化表單。

  2. 選取您要為其編寫規則的表單物件,然後在元件工具列中選取 edit-rules. 規則編輯器使用者介面隨即顯示。

    create-rules

    此檢視中會列出所選表單物件上的任何現有規則。 如需有關管理現有規則的資訊,請參閱 管理規則.

  3. 選取 建立 撰寫新規則。 第一次啟動規則編輯器時,規則編輯器使用者介面的視覺化編輯器預設會開啟。

    規則編輯器UI

讓我們來詳細瞭解規則編輯器UI的每個元件。

A.元件規則顯示

顯示啟動規則編輯器所使用之最適化表單物件的標題,以及目前選取的規則型別。 在上述範例中,規則編輯器是從名為Salary的最適化表單物件啟動,且選取的規則型別是When。

B.表單物件與函式

規則編輯器使用者介面左側的窗格包含兩個標籤 — Forms物件函式.

「表單物件」標籤會顯示最適化表單中包含之所有物件的階層檢視。 它會顯示物件的標題和型別。 撰寫規則時,您可以將表單物件拖放至規則編輯器上。 將物件或函式拖放至預留位置時,在建立或編輯規則時,預留位置會自動採用適當的值型別。

已套用一或多個有效規則的表單物件會以綠色圓點標示。 如果套用至表單物件的任何規則無效,則表單物件會標示為黃點。

函式索引標籤包含一組內建函式,例如Sum Of、Min Of、Max Of、Average Of、Number Of和Validate表單。 您可以使用這些函式計算可重複面板和表格列中的值,並在撰寫規則時在動作和條件陳述式中使用它們。 不過,您可以建立 自訂函式 也是。

函式標籤

注意

您可以在Forms「物件」和「函式」標籤中搜尋物件和函式的名稱及標題。

在表單物件的左側樹狀結構中,您可以選取表單物件,以顯示套用到每個物件的規則。 您不僅可以瀏覽各種表單物件的規則,也可以在表單物件之間複製 — 貼上規則。 如需詳細資訊,請參閱 複製貼上規則.

C.表單物件與功能切換

點選切換按鈕時,會切換表單物件和函式窗格。

D.視覺規則編輯器

視覺化規則編輯器是規則編輯器使用者介面的視覺化編輯器模式中您編寫規則的區域。 它可讓您選取規則型別,並據此定義條件和動作。 在規則中定義條件和動作時,您可以從「表單物件與函式」窗格中拖放表單物件與函式。

如需使用視覺化規則編輯器的詳細資訊,請參閱 寫入規則.

E.完成和取消按鈕

完成 按鈕可用來儲存規則。 您可以儲存不完整的規則。 但是,不完整內容無效,因此不會執行。 當您下次從相同表單物件啟動規則編輯器時,會列出表單物件上已儲存的規則。 您可以在該檢視中管理現有規則。 如需詳細資訊,請參閱 管理規則.

取消 按鈕會放棄您對規則所做的任何變更並關閉規則編輯器。

寫入規則

您可以使用視覺化規則編輯器來撰寫規則 <!> — 或程式碼編輯器>。 當您第一次啟動規則編輯器時,它會在視覺化編輯器模式下開啟。 您可以切換到程式碼編輯器模式並編寫規則。 不過,如果您在程式碼編輯器中撰寫或修改規則,則必須清除程式碼編輯器,才能切換至該規則的視覺化編輯器。 當您下次啟動規則編輯器時,編輯器會以您上次使用來建立規則的模式開啟。

讓我們先來看看如何使用視覺化編輯器來撰寫規則。

使用視覺化編輯器

讓我們瞭解如何使用下列範例表單在視覺化編輯器中建立規則。

Create-rule-example

範例貸款申請表單中的「貸款需求」區段要求申請人指定其婚姻狀況、薪資,如果已婚,則指定其配偶的薪資。 規則會根據使用者輸入來計算貸款資格金額,並顯示在「貸款資格」欄位中。 套用下列規則以實施情境:

  • 配偶的「薪資」欄位僅在「婚姻狀況」為「已婚」時顯示。
  • 貸款資格金額為薪資總額的50%。

若要撰寫規則,請執行下列步驟:

  1. 首先,根據使用者為「婚姻狀況」選項按鈕選取的選項,撰寫規則以控制「配偶薪資」欄位的可見度。

    以編寫模式開啟貸款申請表單。 選取 婚姻狀況 元件並選取 edit-rules. 接下來,選取 建立 以啟動規則編輯器。

    write-rules-visual-editor-1

    啟動規則編輯器時,預設會選取When規則。 此外,您啟動規則編輯器的表單物件(在此例中為「婚姻狀況」)會在When陳述式中指定。

    雖然您無法變更或修改選取的物件,但可以使用規則下拉式清單(如下所示)來選取其他規則型別。 如果您想在其他物件上建立規則,請選取「取消」結束規則編輯器,然後從想要的表單物件再次啟動它。

  2. 選取 選取狀態 下拉式清單並選取 等於. 此 輸入字串 欄位隨即顯示。

    write-rules-visual-editor-2

    在婚姻狀況選項按鈕中, 已婚單一 已指派選項 01 個值。 您可以在「編輯」選項按鈕對話方塊的「標題」標籤中驗證指派的值,如下所示。

    規則編輯器的選項按鈕值

  3. 輸入字串 欄位,請指定 0.

    write-rules-visual-editor-4

    您已將條件定義為 When Marital Status is equal to Married. 接著,定義若此條件為True時要執行的動作。

  4. 在Then陳述式中,選取 顯示選取動作 下拉式清單。

    write-rules-visual-editor-5

  5. 拖放 配偶薪資 欄位。 將物件放下或選取這裡 欄位。 或者,選取 將物件放下或選取這裡 欄位並選取 配偶薪資 欄位,其中列出表單中的所有表單物件。

    write-rules-visual-editor-6

    規則在規則編輯器中會顯示如下。

    write-rules-visual-editor-7

  6. 選取 完成 以儲存規則。

  7. 重複步驟1到5,定義另一個規則,以在「婚姻狀況」為「單身」時隱藏「配偶薪資」欄位。 規則在規則編輯器中會顯示如下。

    write-rules-visual-editor-8

    注意

    或者,您可以在「配偶薪資」欄位上撰寫一個「顯示」規則,而不是在「婚姻狀況」欄位上撰寫兩個「當規則」,以實施相同的行為。

    write-rules-visual-editor-9

  8. 接著,撰寫規則以計算貸款資格金額(為薪資總額的50%),並在「貸款資格」欄位中顯示。 若要獲得此結果,請建立 設定值 貸款資格欄位上的規則。

    在製作模式中,選取 貸款資格 欄位並選取 edit-rules. 接下來,選取 建立 以啟動規則編輯器。

  9. 選取 設定值 規則。

    write-rules-visual-editor-10

  10. 選取 選取選項 並選取 數學運算式. 用於寫入數學運算式的欄位隨即開啟。

    write-rules-visual-editor-11

  11. 在運算式欄位中:

    • 從「Forms物件」標籤中選取或拖放 薪資 第一個欄位 將物件放下或選取這裡 欄位。

    • 選取 加號選取運運算元 欄位。

    • 從「Forms物件」標籤中選取或拖放 配偶薪資 另一個欄位 將物件放下或選取這裡 欄位。

    write-rules-visual-editor-12

  12. 接著,在運算式欄位周圍反白的區域中選取,然後選取 延伸運算式.

    write-rules-visual-editor-13

    在延伸運算式欄位中,選取 除以選取運運算元 欄位和 數字選取選項 欄位。 然後,指定 2 在數字欄位中。

    write-rules-visual-editor-14

    注意

    您可以在「選取選項」欄位中使用元件、函式、數學運算式和屬性值來建立複雜運算式。

    接著,建立條件,當傳回True時,執行運算式。

  13. 選取 新增條件 新增When陳述式。

    write-rules-visual-editor-15

    在When陳述式中:

    • 從「Forms物件」標籤中選取或拖放 婚姻狀況 第一個欄位 將物件放下或選取這裡 欄位。

    • 選取 等於選取運運算元 欄位。

    • 選取其他中的字串 將物件放下或選取這裡 欄位並指定 已婚輸入字串 欄位。

    規則最後會顯示在規則編輯器中,如下所示。 write-rules-visual-editor-16

  14. 選取 完成. 這會儲存規則。

  15. 重複步驟7到14,定義另一個規則,以計算婚姻狀況為「單身」時的貸款資格。 規則在規則編輯器中會顯示如下。

    write-rules-visual-editor-17

注意

或者,您可以使用「設定值」規則,在您建立用來顯示 — 隱藏「配偶薪資」欄位的「時機」規則中,計算貸款資格。 當「婚姻狀況」為「單一」時,產生的合併規則會顯示在規則編輯器中,如下所示。

同樣地,您可以撰寫合併規則來控制「配偶薪資」欄位的可見度,並在「婚姻狀況」為「已婚」時計算貸款資格。

write-rules-visual-editor-18

規則編輯器中的自訂函式

除了開箱即用的功能,例如 總和 列在函式輸出下的自訂函式,您可以編寫經常需要的自訂函式。 請確認您撰寫的函式是否隨附 jsdoc 高於它。

隨附 jsdoc 為必填:

  • 如果您想要自訂設定和說明
  • 因為有多種方式可以在中宣告函式 JavaScript, 和註解可讓您追蹤函式。

規則編輯器支援指令碼和自訂函式的JavaScript ES2015語法。
如需詳細資訊,請參閱 jsdoc.app.

支援 jsdoc 標籤:

  • 私人
    語法: @private
    私人函式不會納入為自訂函式。

  • 名稱
    語法: @name funcName <Function Name>
    或者 , 您可以使用: @function funcName <Function Name> @func funcName <Function Name>.
    funcName 是函式的名稱(不允許空格)。
    <Function Name> 是函式的顯示名稱。

  • 會員
    語法: @memberof namespace
    將名稱空間附加至函式。

  • 引數
    語法: @param {type} name <Parameter Description>
    或者,您可以使用: @argument {type} name <Parameter Description> @arg {type} name <Parameter Description>.
    顯示函式使用的引數。 一個函式可以有多個引數標籤,每個引數會依發生順序各一個標籤。
    {type} 代表引數型別。 允許的引數型別為:

    1. 字串
    2. 數字
    3. 布林值
    4. 範圍

    範圍是指最適化表單的欄位。 表單使用緩慢載入時,您可以使用 scope 以存取其欄位。 您可以在載入欄位時存取欄位,或者如果欄位標示為全域。

    所有引數型別都會歸類到上述其中一種型別下。 不支援任何專案。 請確定您選取以上任一型別。 型別不區分大小寫。 引數中不允許空格 name. <Parameter Descrption> <parameter> can have multiple words. </parameter>

  • 傳回型別
    語法: @return {type}
    或者,您可以使用 @returns {type}.
    新增函式的相關資訊,例如其目標。
    {type} 代表函式的傳回型別。 允許的傳回型別為:

    1. 字串
    2. 數字
    3. 布林值

    所有其他回訪型別則會歸類到上述任一型別下。 不支援任何專案。 請確定您選取以上任一型別。 傳回型別不區分大小寫。

    • 這個
      語法: @this currentComponent

    使用@this可參照寫入規則的最適化表單元件。

    以下範例是根據欄位值。 在以下範例中,規則會隱藏表單中的欄位。 此 this 部分 this.value 是指寫入規則的基礎調適型表單元件。

       /**
       * @function myTestFunction
       * @this currentComponent
       * @param {scope} scope in which code inside function is run.
       */
       myTestFunction = function (scope) {
          if(this.value == "O"){
                scope.age.visible = true;
          } else {
             scope.age.visible = false;
          }
       }
    
    注意

    使用自訂函式之前的註解作為摘要。 摘要可以延伸至多行,直到遇到標籤為止。 將大小限製為單一,以在規則產生器中提供簡要說明。

新增自訂函式

例如,您想要新增計算正方形區域的自訂函式。 側邊長度是自訂函式的使用者輸入,可使用表單中的數字方塊來接受。 計算的輸出會顯示在表單的另一個數值方塊中。 若要新增自訂函式,您必須先建立使用者端資料庫,然後將其新增到CRX存放庫。

若要建立使用者端程式庫並將其新增到CRX存放庫中,請執行以下步驟:

  1. 建立使用者端資源庫。 如需詳細資訊,請參閱 使用使用者端資料庫.

  2. 在CRXDE中新增屬性 categories字串型別值為 customfunctionclientlib 資料夾。

    注意

    customfunction是範例類別。 您可以為在中建立的類別選擇任何名稱 clientlib資料夾。

在CRX存放庫中新增使用者端程式庫後,請將其用於最適化表單。 它可讓您使用自訂函式作為表單中的規則。 若要在最適化表單中新增使用者端程式庫,請執行下列步驟:

  1. 在編輯模式中開啟您的表單。
    若要以編輯模式開啟表單,請選取表單並選取 開啟.

  2. 在編輯模式中,選取元件,然後選取 欄位層級 > 最適化表單容器,然後選取 cmppr.

  3. 在側邊欄中的「使用者端資料庫名稱」下方,新增您的使用者端資料庫。 ( customfunction 在此範例中。)

    新增自訂函式使用者端程式庫

  4. 選取輸入數字方塊,然後選取 edit-rules 以開啟規則編輯器。

  5. 選取 建立規則. 使用下列選項,建立規則以將輸入的平方值儲存在表單的「輸出」欄位中。

    使用自訂函式建立規則

  6. 選取 完成. 您的自訂函式已新增。

    注意

    若要使用自訂函式從規則編輯器叫用表單資料模型, 請參閱此處.

函式宣告支援的型別

函式陳述式

function area(len) {
    return len*len;
}

此函式包含但不包含 jsdoc 評論。

函式運算式

var area;
//Some codes later
/** */
area = function(len) {
    return len*len;
};

函式運算式和陳述式

var b={};
/** */
b.area = function(len) {
    return len*len;
}

函式宣告為變數

/** */
var x1,
    area = function(len) {
        return len*len;
    },
    x2 =5, x3 =true;

限制:自訂函式只會從變數清單中挑選第一個函式宣告(如果同時挑選)。 您可以對每個宣告的函式使用函式運算式。

函式宣告為物件

var c = {
    b : {
        /** */
        area : function(len) {
            return len*len;
        }
    }
};
注意

請務必使用 jsdoc 每個自訂函式。 雖然 jsdoc建議加入註解,包含空白 jsdoc備註以將您的函式標示為自訂函式。 它會啟用自訂函式的預設處理。

管理規則

當您選取物件並選取時,會列出表單物件上的任何現有規則 edit-rules1. 您可以檢視標題並預覽規則摘要。 此外,UI可讓您展開並檢視完整的規則摘要、變更規則順序、編輯規則及刪除規則。

List-rules

您可以對規則執行下列動作:

  • 展開/摺疊:規則清單中的「內容」欄會顯示規則內容。 如果預設檢視中看不到整個規則內容,請選取「 」 expand-rule-content 以展開它。

  • 重新排序:您建立的任何新規則都會棧疊在規則清單底部。 規則會從上到下執行。 頂端的規則會先執行,接著執行相同型別的其他規則。 例如,如果您分別從頂端開始,在第一、第二、第三和第四個位置有When、Show、Enable和When規則,則頂端的規則會先執行,接著在第四個位置有When規則。 接著會執行「顯示」和「啟用」規則。
    您可以點選以變更規則的順序 sort-rules 或將其拖放到清單中的所需順序。

  • 編輯:若要編輯規則,請選取規則標題旁的核取方塊。 隨即顯示編輯和刪除規則的選項。 選取 編輯 在規則編輯器中開啟選取的規則 .

  • 刪除:若要刪除規則,請選取該規則並選取 刪除.

  • 啟用/停用:您必須暫時暫停使用規則時,可以選取一或多個規則並選取 停用 以停用。 如果規則已停用,則不會在執行階段執行。 若要啟用已停用的規則,您可以選取該規則,然後選取動作工具列中的「啟用」 。 規則的狀態列顯示規則是啟用還是停用。

停用規則

複製貼上規則

您可以將規則從一個欄位複製並貼上到其他類似欄位,以節省時間。

若要複製貼上規則,請執行下列動作:

  1. 選取您要從中複製規則的表單物件,然後在元件工具列中選取 編輯規則. 規則編輯器使用者介面會出現,並選取表單物件,而現有規則會出現。

    複製規則

    如需有關管理現有規則的資訊,請參閱 管理規則.

  2. 選取規則標題旁的核取方塊,管理規則的選項就會出現。 選取 複製.

    copyrule2

  3. 選取另一個要貼上規則的表單物件,然後選取 貼上. 此外,您可以編輯規則以對其進行變更。

    注意

    只有當表單物件支援所複製規則的事件,您才能將規則貼到另一個表單物件。 例如,按鈕支援點選事件。 您可以將具有點選事件的規則貼到按鈕上,但無法貼到核取方塊上。

  4. 選取 完成 以儲存規則。

巢狀運算式

規則編輯器可讓您使用多個AND和OR運運算元來建立巢狀規則。 您可以在規則中混合使用多個AND和OR運運算元。

以下是巢狀規則的範例,該規則會在符合所需條件時,向使用者顯示有關子女監護權的資格的訊息。

複雜運算式

您也可以拖放規則中的條件以進行編輯。 選取並將滑鼠懸停在控點上( 控點)。 指標變成如下所示的手形符號後,請將條件拖放至規則內的任何位置。 規則結構會變更。

拖放

日期運算式條件

規則編輯器可讓您使用日期比較來建立條件。

以下是一個範例條件,會在房屋抵押貸款已辦理時顯示靜態文字物件,使用者填寫日期欄位即表示該條件。

當使用者填寫的屬性按揭日期為過去時,最適化表單會顯示收入計算的相關備註。 下列規則會比較使用者填寫的日期與目前日期,如果使用者填寫的日期早於目前日期,則表單會顯示文字訊息(名為「收入」)。

日期運算式條件

當填寫日期早於目前日期時,表單會顯示文字訊息(收入)如下:

符合日期運算式條件

數字比較條件

規則編輯器可讓您建立比較兩個數字的條件。

如果應徵者在目前地址停留的月數少於36,則會顯示靜態文字物件的範例條件如下。

數字比較條件

當使用者表示在目前的居住地址生活少於36個月時,表單會顯示通知,要求更多居住證明。

已要求更多校訂

規則範例

啟動表單資料模型服務

考慮使用Web服務 GetInterestRates 以貸款金額、保有權及申請者的信用評分作為輸入,並傳回包含EMI金額和利率的貸款計畫。 您可以使用Web服務作為資料來源來建立表單資料模型。 您新增資料模型物件和 get 表單模型的服務。 此服務會出現在表單資料模型的「服務」標籤中。 接著,建立包含資料模型物件欄位的最適化表單,以擷取貸款金額、使用期限和信用評分的使用者輸入。 新增觸發Web服務擷取計畫詳細資料的按鈕。 輸出會填入適當的欄位中。

下列規則顯示如何設定叫用服務動作來完成範例案例。

Example-invoke-services

注意

如果輸入為陣列型別,則支援陣列的欄位會顯示在「輸出」下拉式區段下。

使用When規則觸發多個動作

在貸款申請表單中,您想要擷取貸款申請人是否為現有客戶。 根據使用者提供的資訊,客戶ID欄位應顯示或隱藏。 此外,如果使用者是現有客戶,您想要將焦點設定在客戶ID欄位。 貸款申請表單包含下列元件:

  • 單選按鈕, 您是Geometrixx現有客戶嗎?,可提供 是 和 否 選項。 「是」的值為 0 而否 1.

  • 文字欄位, Geometrixx客戶ID,以指定客戶ID。

當您在選項按鈕上編寫實施此行為的When規則時,該規則在視覺規則編輯器中會顯示如下。

When-rule-example

視覺化編輯器中的規則

在範例規則中,When區段中的陳述式是條件,當傳回True時,會執行Then區段中指定的動作。

在規則中使用函式輸出

在採購單表單中,您有下表,使用者可在其中填寫訂單。 在此表格中:

  • 第一列是可重複的,因此使用者可以訂購多個產品並指定不同的數量。 其元素名稱為 Row1.
  • 重複資料列之「產品數量」欄中的儲存格標題為「數量」。 此儲存格的元素名稱為 productquantity.
  • 表格中的第二列是不可重複的,且此列中「產品數量」欄中的儲存格標題為「總數量」。

Example-function-table

答: Row1 B. 數量 C. 總數量

現在,您要在所有產品的「產品數量」欄中新增指定數量,並在「總數量」儲存格中顯示總和。 您可以在「總數量」儲存格上撰寫「設定值」規則,以達到此總和,如下所示。

Example-function-output

視覺化編輯器中的規則

使用運算式驗證欄位值

在上一個範例中說明的採購單表單中,您想要限制使用者訂購超過一10000數量的產品。 若要執行此驗證,您可以編寫驗證規則,如下所示。

Example-validate

視覺化編輯器中的規則

本頁內容