結構節點和屬性

任何元素只要未明確標示為欄位以外的類型，欄位類型便為其預設類型。因此，您實際上一律不需要將元素明確標示為欄位。請注意，欄位元素與群組或列表不同，會在其節點而非其他節點中包含資訊。

群組元素通常僅是結構的結構元素，在此情況下，它並無對應。

請注意，將數個都用來對應業務物件導向記錄之 CLOB/XML 欄位 XML 結構的元素分組時，可以在群組層級進行對應。

使用群組來建立結構的範例

<schema>
  <input type="group"
    <userId/>
  </input>
  <output type="group">
    <firstName/>
    <lastName/>
  </output>
</schema>

群組包含對應的範例：

<parameters type="group" 
mapXML="BO_DATA_AREA" mdField=
"F1_TODOSUMEMAIL_PARM_LBL"/>
  <numberOfDays 
  mdField="F1_NBR_DAYS" 
  required="true"/>
  <frequency 
   mdField="F1_FREQUENCY"/>

列表節點是類似群組節點的結構節點。唯一的差異在於列表結構能夠在 XML 文件中重複多次。

含有列表的結構範例：

<schema>
  <statesList type="list">
    <state isPrimeKey="true"/>
    <description/>
  </statesList>
</schema>

含有列表的結構範例：

<xml>
  <statesList>
    <state>AK</state>
    <description>Alaska</description>
  </statesList>
  <statesList>
    <state>AL</state>
    <description>Alabama</description>
  </statesList>
...
</xml>

原始資料類型可用來擷取沒有任何相關固有結構的原始文字區塊。

<sendDetail type="raw" />

上述結構的 XML 實例範例：

<sendDetail>
  <messageInfo>
    <senderAddress>123 W. Main St,    Ontario, CA
    </senderAddress>
    <corpZone>3A</corpZone>
  </messageInfo>
</sendDetail>

欄位元素預設為字串。因此，無須指定字串資料類型。

<schema>
  <custName dataType="string"/>
</schema>

定義身為數字的元素。

範例

<schema>
  <count dataType="number"/>
</schema>

<schema>
  <taxRate dataType="number" 
   currencyRef="currency"/>
</schema>

選擇性額外屬性

定義代表貨幣金額的元素。

您可以視需要使用幣別參考，如果留白，則會使用安裝幣別。要根據幣別套用的自動格式設定與驗證。例如，自動轉譯時，將會顯示幣別符號。此外，小數位數不可超過為幣別定義的有效數目。

<schema>
  <currency default="USD" 
    suppress="true"/>
  <balance dataType="money" 
   currencyRef="currency"/>
</schema>

必要額外屬性

定義具有以查尋定義之有效值的元素。查尋欄位為必要欄位。

<schema>
  <status dataType="lookup" 
   lookup="STATUS_FLG"/>
</schema>

必要額外屬性

定義具有以可延伸查尋定義之有效值的元素。可延伸查尋的業務物件為必要物件。

<schema>
  <category dataType="lookupBO" 
   lookupBO="CM-BusinessCategory"/>
</schema>

定義具有 "Y" 和 "N" 值的元素。

<schema>
  <allowsEdit dataType="boolean"/>
</schema>

定義代表日期的元素。

<schema>
  <startDate dataType="date"/>
</schema>

"dateTime"

定義代表日期和時間的元素。

<schema>
  <startDateTime 
  dataType="dateTime"/>
</schema>

定義代表時間的元素。

<schema>
  <startTime dataType="time"/>
</schema>

定義擷取 URI 的元素。以此類型定義的元素可用來支援 URI 允許列表與替代，如參考 URI 所述。

<schema>
  <exportDirectory dataType="uri"/>
</schema>

就業務物件而言，mapField 屬性可用來識別元素相關的資料庫資料欄。針對業務服務結構，mapField= 屬性則可用來將結構元素與服務元素連結。

<schema>
  <factId 
   mapField="FACT_ID"/>
</schema>

mapChild 屬性僅用於業務物件對應。其使用方式有兩種：

• 第一種，在業務物件中建立一個對應維護物件下階資料表的列表。

• 第二種，您可以使用 mapChild 來識別扁平化欄位所在的下階資料表。如需有關扁平化的資訊，請參考下方的扁平化小節。

<persons type="list" 
   mapChild="CI_ACCT_PER"
  <personId mapField="PER_ID"/>
</persons>

mapList 屬性僅用於業務服務對應。其使用方式有兩種：

• 第一種，在業務服務中建立一個對應服務中列表的列表。

• 第二種，您可以使用 mapList 來識別扁平化欄位所在的列表。如需有關扁平化的資訊，請參考下方的扁平化小節。

<selectList type="list" 
  mapList="DE" 
  <value mapField="COL_VALUE"> 
    <row mapList="DE_VAL"> 
      <SEQNO is="2"/> 
    </row> 
  </value>  
</selectList>

mapXML 屬性通常用來將 XML 結構對應至服務的大型字元/XML 欄位。請注意，使用 mapXML 來對應列表或群組結構 (type="list" 或 type="group") 時，您不需要對應結構內的所有下階元素。您也可以將列表元素對應至與列表下階相關的大型字元欄位。

<enrollmentRequest type="group" 
mapXML="CASE_CLOB">
  <messageID/>
  <sender/>
</enrollmentRequest>
<enrollmentKey 
mapXML="CASE_CLOB"/>
<enrollmentInfo type="list" 
mapChild="CI_CASE_CHILD">
  <sequence 
  mapField="CHILD_SEQ"/>
  <name 
  mapXML="CASE_CHILD_CLOB"/>
  <value 
  mapXML="CASE_CHILD_CLOB"/>
</enrollmentInfo>

您必須為所對應 XML 元素內定義的列表 (type="list" mapXML="CLOB") 指定主索引鍵。架構會使用主索引鍵來判斷進行業務物件更新時，是否需要新增、更新或刪除列表元素。

<questionnaire 
type="list" mapXML="CASE_CLOB">
  <question 
  isPrimeKey="true"/>
  <answer/>
</questionnaire>

所對應 XML 元素內定義的列表 (type="list" mapXML="CLOB") 預設會依列表的第一個元素排序。您可以使用 orderBy 屬性來指定不同的排序順序。屬性值是一個以逗號分隔的列表，由欄位 XPath (相對於列表元素) 與選擇性的排序順序 (預設值為遞增) 所組成。

<questionnaire type="list" 
  orderBy="page/section, 
page/sequence" 
mapXML="CASE_CLOB">
<question isPrimeKey="true"/>
<answer/>
<page type="group">
  <section/>
  <sequence/>
</page>
</questionnaire>

使用此屬性以特殊的左右字元 <!-- 和 --> 將註釋新增至結構。

<schema>
  <!-- This schema is used to 
capture business information 
only, please refer to the 
'HUMAN' BO for person 
information -->
</schema>

元素的描述可用來提供元素的內部描述，以協助結構的讀取者瞭解該元素的業務原因。

<schema>
  <active type="boolean" 
description="active account" 
label="Active"/>
</schema>

元素的標籤應該是一小段用語，通常置於使用者介面中元素的前方。

<schema>
  <active type="boolean" 
description="active account" 
label="Active"/>
</schema>

用來在進行物件互動時，要求元素必須存在。

<schema>
  <logDate mapField="LOG_DT" 
default="%CurrentDate" 
required="true" 
private="true"
</schema>

中繼資料欄位屬性可用來將元素與欄位的中繼資料建立關聯。此欄位會定義資料類型，以及其標籤與說明文字。如果您將元素與中繼資料欄位連結，便無需指定任何這些屬性。

<schema>
  <active 
mdField="CM_ACTIVE_SW"/>
</schema>

如果元素是外來索引鍵，定義其外來索引鍵參考會在進行結構互動時啟用元素架構驗證，並自動提供描述與導覽功能。

<schema>
  <person fkRef="PER" 
mapField="CHAR_VAL_FK1">
   <row mapChild="CI_SA_CHAR">
      <CHAR_TYPE_CD is="PER"/>
    </row>
  </person>
</schema>

將元素設為私人可防止在結構互動中公開該元素。

<schema>
  <type mdField="SA_TYPE_CD" 
default="E1" private="true"/>
</schema>

此設定可防止元素出現在自動產生的使用者介面中。

<schema>
    <ls mdField="LIFE_SUPPORT_FLG" 
default="N" suppress="true"/<
</schema>

此設定意謂著處於顯示模式的自動 UI 轉譯會將值空白的元素隱藏。元素不論是否空白，在輸入對應上都仍將可以修改。

<schema>
  <email mdField="EMAIL" 
suppress="blank"/>
</schema>

此設定意謂著自動 UI 轉譯會隱藏用於輸入的元素，但如果元素並非空白，則仍可能會顯示。

<schema>
  <email mdField="EMAIL" 
suppress="input"/>
</schema>

此設定可防止元素在業務物件的稽核外掛點中顯示為已變更的元素。如果在群組或列表節點上指定，就會套用至整個節點。您無法在結構根節點上指定它，只能在結構元素上指定。

<schema>
  ...
  <version mapField="VERSION_NBR"
 noAudit="true"/>
  ...
  <workFields type="group"
 noAudit="true"
    <lastProcessedId/>
    <lastProcessedTime/>
  </workFields>
</schema>

儲存時預設會將空白節點從業務物件執行環境中移除。此設定可讓群組或列表元素明確保留其空白節點。

在與外部系統交換業務物件資料而必須區分以下兩種情況時，此屬性即可派上用場：元素參與同步，且值為空值；元素未參與同步，因此訊息中完全予以省略。

<schema>
  <message type="group" storeEmptyNodes="true">
  ...
  </message>
</schema>

根據預設，系統不會將空白節點包含在業務物件或業務服務要求的輸出中。此屬性是設定在最上層的結構節點，讓所有群組和列表元素的空白節點可以被包含在輸出中。

此屬性在需要使用 storeEmptyNodes= 屬性的相同情況下也很有用。

<schema emitEmptyGroups="true">
  <message type="group">
  ...
  </message>
</schema>

此屬性與 emitEmptyGroups= 屬性類似，但您也可在欄位層級指定該屬性。此屬性適用於所有結構類型。

<schema>
  <messageNumber type="field" emitEmptyElements="true">
  ...
  </message>
</schema>

此屬性適用於結構、群組及列表節點。其宣稱基於一般多樣性原因，此子結構節點旨在與其中一個所列資料區域的結構「類似」。

<schema>
  <messageNumber type="group" adheresToDA="DataAreaName">
  ...
  </message>
</schema>

<schema>
  <perType mapField="PER_OR_BUS_FLG" 
default="P" required="true"/>
</schema>

<schema>
  <frequency dataType="number" 
default="1" required="true"/>
</schema>

<schema>
  <logDate mapField="LOG_DT" 
default="%CurrentDate" required="true"/>
</schema>

<schema>
  <logDateTime mapField="LOG_DTTM" 
default="%CurrentDateTime" 
required="true"/>
</schema>

<schema>
  <startDateTime mapField="START_DTTM" 
default="%StandardDateTime" 
required="true"/>
</schema>

<schema>
  <billDate mapField="BILL_DT" 
default="%ProcessDate" 
required="true"/>
</schema>

<schema>
  <calcDateTime mapField="CALC_DTTM" 
default="%ProcessDateTime" 
required="true"/>
</schema>

<schema>
  <logUser mapField="LOG_USER" 
default="%CurrentUser" 
required="true"/>
</schema>

<schema>
  <timeZone 
default="%CurrentUserTimeZone" 
required="true"/>
</schema>

<schema>
  <custLanguage mapField="CUST_LANG" 
default="%CurrentUserLanguage" 
required="true"/>
</schema>

<schema>
  <currency mapField="CURRENCY_CODE" 
default="%InstallationCurrency" 
required="true"/>
</schema>

<schema>
  <country mapField="COUNTRY" 
default="%InstallationCountry" 
required="true"/>
</schema>

<schema>
  <language mapField="LANGUAGE" 
default="%InstallationLanguage" 
required="true"/>
</schema>

<language mapField="CUSTOMER_LANG" 
default="%Constant(customerLanguage)" 
required="true"/>

<source mapField="PER_ID" 
default="%Context(source)" 
required="true"/>

使用此屬性將一個元素的值預設為另一個元素的值。

如需用於參考其他元素的支援語法，請參閱參考其他元素。

<tdTypeCd 
  mapField="CHAR_VAL_FK1">
  <row 
    mapChild="F1_EXT_LOOKUP_VAL_CHAR">
    <CHAR_TYPE_CD 
   is="CM-TD-TYPE"/>
  </row>
</tdTypeCd>

在扁平化語法中使用結構常數的範例，其中查尋欄位值的 Java 值名稱為 'cmRate'。

<unitRate mapField="CHAR_VAL" 
  dataType="number">
  <row mapChild=
   "F1_EXT_LOOKUP_VAL_CHAR">
    <CHAR_TYPE is
   ="%Constant(cmRate)"/>
  </row>
</unitRate>

<schema>
  <mainPhone mapField="PHONE">
    <row mapChild="CI_PER_PHONE">
      <PHONE_TYPE_CD 
      is="%Constant(mainPhoneType)"/>
      <SEQ_NUMis="%1"/>
    </row>
  </mainPhone>
</schema>

<schema>
  <price mapField="CHAR_VAL" 
   dataType="number" required="true">
    <row mapChild="CI_SA_CHAR">
      <CHAR_TYPE is="PRICE"/>
      <EFFDT 
   is="%effectiveDate(priceEdate)" />
    </row>
  </price>
<priceEdate mapField="EFFDT" 
  rowRef="price"/>
</schema>

<schema>
  <price mapField="CHAR_VAL" 
  dataType="number">
    <row mapChild="RATE_CHAR">
      <CHAR_TYPE is="PRICE"/>
      <EFFDTTM 
  is="%effectiveDateTime(priceEdatetime)"/>
    </row>
  </price>
  <priceEdatetime mapField="EFFDTTM" 
  rowRef="price"/>
</schema>

不建議您使用此組態

<schema>
  <price mapField="CHAR_VAL" 
  dataType="number">
    <row 
  mapChild="CI_SA_CHAR">
      <CHAR_TYPE is="PRICE"/>
      <EFFDT
   is="%effectiveDate"/>
    </row>
  </price>
</schema>

不建議您使用此組態

<schema>
  <price mapField="CHAR_VAL" 
   dataType="number">
    <row mapChild="RATE_CHAR">
      <CHAR_TYPE is="PRICE"/>
      <EFFDT 
    is="%effectiveDateTime" />
    </row>
  </price>
</schema>

<includeBO name=" "/>

允許將業務物件結構包含在另一個結構中。

請注意，業務物件或業務服務結構的對應規則在上階結構內容中可能有意義，也可能沒意義。包含其他結構須自負風險。不過，XML 處理有一個非常實用之處，就是架構會忽略非相關的屬性。換句話說，將對應屬性包含在指令檔結構中不會有什麼壞處。

<schema>
  <cust type="group">
<includeBO name="C1-Person"/>
</cust>
  <spouse type="group">
<includeBO name="C1-Person"/>
</spouse>
</schema>

<includeBS name=" "/>

用來包含業務服務結構。

<schema>
<includeBS name="F1-ReadMOLog"/>
</schema>

<includeDA name=" "/>

用來包含資料區域結構。

<schema>
<includeDA 
   name="F1CommonSchemaFieldData"/>
</schema>

<includeMP name=" "/>

用來包含 UI 對應結構。

<schema>
<includeMP 
   name="F1-DisplayRecordActions"/>
</schema>

<includeSS name=" "/>

用來包含服務指令檔結構。

<schema>
<includeSS name="F1-ActShowZn"/>
</schema>