外掛指令檔的 API

就像程式型外掛一樣,外掛指令檔:

  • 在應用程式伺服器上執行。
  • 擁有自己的 API (輸入/輸出介面),這是由外掛點所定義的 (亦即外掛指令檔無法宣告自己的 API)。
  • 只能由「外掛點驅動程式」叫用。

對於設定為使用指令檔引擎版本的外掛,瞭解指令檔 API 的最佳方式是使用檢視指令檔結構超連結以檢視其參數資料區域結構。

外掛資料區域結構

請注意兩個群組:軟和硬。如果您熟悉外掛點,您會將它們辨識為典型軟參數和硬參數:

  • 參數是演算法中定義的參數值。請注意,它們尚未命名 - 如果您想在自己的外掛指令檔中參考它們,就必須依照位置來執行。
  • 參數由外掛點 (即演算法實體) 所控制。請注意,此外掛點有一個名為 "businessObject/id" 的單一輸入參數。另請注意 use= 屬性 - 這表示此參數僅限輸入 (也就是,您無法在外掛指令檔中進行變更)。
備註:XPath。您可以按一下元素名稱,以查看用來參考指令檔中之元素的 XPath。

設定為使用 Groovy 引擎版本的外掛不使用 API 的 XML 介面,而是以與 Java 演算法相同的方式處理。該架構提供動態產生的超級類別,可實作 Groovy 物件的外掛點。使用檢視指令檔超級類別超連結,來檢視此超級類別以及設定和取得硬參數的方式。

備註:對於使用 Groovy 引擎版本的外掛指令檔,軟參數不會出現在外掛點 API 中 (如超級類別所定義)。僅使用 Groovy 代碼的外掛會以類似於 Java 演算法的方式使用註釋,並使用演算法代碼中定義的方式來擷取這些值。