更新模型中的標籤和欄位名稱

模型的 label 元素可控制使用者介面中出現的標籤或欄位名稱,以說明給定內容。您可以更新邏輯模型來變更預設標籤或提供本地化(翻譯)。

開始之前

在您以任何方式變更邏輯模型之前,請先檢閱更新邏輯模型時的限制中列出的規則和限制。

關於這項作業

模型設計為可在特定限制內延伸。通常,當延伸模型時,現行模型元素需要持續保存在未來的模型更新項目中。因此,當您需要延伸模型時,應該先取得現行模型。

註: 如需 label 元素的相關資訊,請參閱邏輯模型中使用的元素及旗標
如果您要變更預設標籤
請取代與模型中適當 label 元素之 default 子元素相關聯的字串值。如需此情況的範例,請參閱下列範例一節中的「標籤案例 1」。
如果您要變更或新增本地化標籤
  1. 請識別您要新增或編輯之語言環境的本地化代碼。若為美國英文,則代碼為 en-US。若為西班牙文,則代碼為 es
    註: 使用標籤本地化時,您必須使用標準語言環境代碼。如需語言環境的相關資訊,請參閱 IETF BCP 47,其由 RFC 4647「比對語言標記」及 RFC 5646「用於識別語言的標籤」組成,可支援 LDML(UTS#35,「Unicode 語言環境資料標記語言」)BCP 47 相容延伸,以進行語言環境資料交換。
  2. 在適當 label 元素的 locales 子元素中,尋找適當的語言環境代碼,並取代與這個特定的語言環境索引鍵相關聯的字串值。如需此情況的範例,請參閱下列範例一節中的「標籤案例 2」。

    如果在元素內找不到您需要的語言環境代碼,請新增或使用其更一般性的形式。例如,如果 Web 用戶端語言環境代碼為 en-US,則您只需使用 en 語言環境代碼將它一般化即可,而這個語言環境代碼將套用至完整的一組 "en" 語言環境,包括 en-US,以及 en-GB(代表英國英文)與 en-CA(代表加拿大英文)。如需此情況的範例,請參閱下列範例一節中的「標籤案例 3」。

註: 如需邏輯模型結構和元素的相關資訊,請參閱邏輯模型概觀及參照

程序

  1. 使用 GET 指令來提取現行模型。
    GET /api/model
    回應為現行邏輯模型。找出包含您想要延伸之記錄類型的模型部分。例如:
    {
    	"recordTypes": [
    		{
    			"name": "Person",
    			"matchable": true,
    			"mappable": true,
    			"properties": [
    				{
    					"name": "Gender",
    					"dataType": "String",
    					"cardinality": "*",
    					"example": "M",
    					"searchable": true,
    					"mappable": true,
    					"label": {
    						"default": "Gender",
    						"locales": {
    							"en": "Gender",
    							"es": "Género",
    							"fr": "Genre"
    						}
    					}
    				},
    			],
    			"label": {
    				"default": "Person",
    				"locales": {
    					"en": "Person",
    					"es": "Persona",
    					"fr": "Personne"
    				}
    			}
    		}
    	]
    }
  2. 視需要編輯或新增適當的 label 元素。 如需實務範例及模型變更,請參閱下面的「範例」一節。
  3. 使用 PUT 指令,以利用更新的模型來更新產品。
    PUT /api/model
  4. 再次使用 GET 指令,以擷取模型並確認您的變更已到位。
    GET /api/model

範例

標籤案例 1
如果您要更新 Gender 內容的預設標籤,讓它全部都是大寫 (GENDER),則在移除所有本地化標籤時,請在使用 PUT 指令更新產品之前,先進行下列模型變更。
{
	"recordTypes": [
		{
			"name": "Person",
			"matchable": true,
			"mappable": true,
			"properties": [
				{
					"name": "Gender",
					"dataType": "String",
					"cardinality": "*",
					"example": "M",
					"searchable": true,
					"mappable": true,
					"label": {
						"default": "GENDER",
						"locales": {
						}
					}
				},
			],
			"label": {
				"default": "Person",
				"locales": {
					"en": "Person",
					"es": "Persona",
					"fr": "Personne"
				}
			}
		}
	]
}

任何語言環境若進行此變更,「性別」欄位的標籤會顯示為 GENDER

標籤案例 2
如果您要為 Gender 內容新增全都大寫的美國英文 (en-US) 本地化標籤 (GENDER),請在使用 PUT 指令更新產品之前,進行下列模型變更。
{
	"recordTypes": [
		{
			"name": "Person",
			"matchable": true,
			"mappable": true,
			"properties": [
				{
					"name": "Gender",
					"dataType": "String",
					"cardinality": "*",
					"example": "M",
					"searchable": true,
					"mappable": true,
					"label": {
						"default": "Gender",
						"locales": {
							"en": "Gender",
							"en-US": "GENDER",
							"es": "Género",
							"fr": "Genre"
						}
					}
				},
			],
			"label": {
				"default": "Person",
				"locales": {
					"en": "Person",
					"es": "Persona",
					"fr": "Personne"
				}
			}
		}
	]
}

進行此變更後,美國英文語言環境會將標籤顯示為 GENDER,而其他英文語言環境則會繼續將標籤顯示為 Gender

標籤案例 3
如果您要為 Gender 內容提供新的全部都大寫的英文 (en) 本地化標籤 (GENDER),請在使用 PUT 指令更新產品之前,進行下列模型變更。
{
	"recordTypes": [
		{
			"name": "Person",
			"matchable": true,
			"mappable": true,
			"properties": [
				{
					"name": "Gender",
					"dataType": "String",
					"cardinality": "*",
					"example": "M",
					"searchable": true,
					"mappable": true,
					"label": {
						"default": "Gender",
						"locales": {
							"en": "GENDER",
							"es": "Género",
							"fr": "Genre"
						}
					}
				},
			],
			"label": {
				"default": "Person",
				"locales": {
					"en": "Person",
					"es": "Persona",
					"fr": "Personne"
				}
			}
		}
	]
}

進行此變更後,所有英文語言環境會將標籤顯示為 GENDER



前次更新: 2018 年 11 月