自動インクリメントフィールド

DXP 2024.Q1+/ポータル GA112+

自動インクリメント フィールドは、人間が読める形式でオブジェクトのエントリを一意に識別するための構成可能な 読み取り専用フィールド です。 たとえば、IT チケット システムでは、ユーザーが各エントリを簡単に参照できるように、各チケットに対して一意かつ意味のある識別子を生成する必要があります。

敬称	初期値	サフィックス	値の例
人生-	2000	-レイ	ライフ2000レイ ライフ2001レイ ライフ2002レイ … ライフ3048レイ
なし	0	なし	0 1 2 … 256
FOO-	01	なし	FOO-01 FOO-02 FOO-03 … FOO-12

注

自動インクリメントフィールドは、Liferay DXP 2024.Q2/Portal GA120 で リリース機能から一般公開 (GA) に移動されました。

開始の数値を設定する必要があります。 Liferay は、後続のオブジェクトエントリごとにこの値に 1 を追加します。 オプションで、各数値に意味のある接尾辞や接頭辞を追加できます。

フィールドを編集するときに、ラベルを変更したり、検索方法を設定したりできます。

自動増分フィールドを使用したエントリのエクスポートとインポート

オブジェクト エントリは、 データ移行センター、 バッチ クライアント拡張機能、または バッチ エンジンのインポート/エクスポート タスク エンドポイントを呼び出すことによってインポートおよびエクスポートされます。

自動インクリメント フィールドを持つエントリをエクスポートすると、エクスポートされた JSON 内の値が保持されます。 自動増分フィールドを含むエントリをインポートする場合は、データがオブジェクト定義の既存のエントリと互換性があるかどうかを慎重に考慮する必要があります。

インポートされたエントリには、一意の 外部参照コード (ERC) と一意の自動増分値の両方が必要です。

ユニークなERC	一意の自動増分値	インポート成功
✔	✔	✔
✘	✔	✘
✔	✘	✘

このルールに従わないと、一貫性のない結果が生じます。 一意の ERC を持ち、自動増分値が重複しているエントリをインポートすると、一意の値を持つエントリのみが正常にインポートされます。

既存のエントリ ERC/自動インクリメント	インポートするエントリ ERC/自動インクリメント	インポート結果 ERC/自動インクリメント
11111/foo-01-bar 22222/foo-02-bar	33333/foo-01-bar 44444/foo-02-bar 55555/foo-03-bar 66666/foo-04-bar 77777/foo-05-bar	11111/foo-01-bar 22222/foo-02-bar 55555/foo-03-bar 66666/foo-04-bar 77777/foo-05-bar

ホスト システムで定義された自動増分形式に従わないエントリをインポートする場合は、指定された形式に従う値のみが正常にインポートされます。

既存のエントリ 有効な自動増分値	インポートするエントリ 自動増分値	インポート結果 有効な自動インクリメント値
foo-01-bar foo-02-bar	foo-003-bar foo-4-bar life-05-ray foo-04-bar foo-05-bar	foo-01-bar foo-02-bar foo-04-bar foo-05-bar

エントリをインポートすると、インポート後のシステム内の最高数値が、新しいフィールド値を増分するために使用される値になります。

自動増分フィールドに値のないエントリをインポートすると、指定されたプレフィックス/サフィックスの形式に従ってエントリが生成され、そのシリーズの次の数値が使用されます。

API で自動インクリメント フィールドを使用する

自動インクリメント フィールドを持つオブジェクト エントリを返す GET リクエストを行うと、値は JSON 文字列として返されます。

"ticket" : "ticket-12"

ヘッドレスAPIでオブジェクト定義フィールドを追加するには、このようなPOSTリクエスト・ボディを使う。

{
   "businessType": "AutoIncrement",
   "label": {
      "en_US": "Able Ticket"
   },
   "name": "ableTicket",
   "objectFieldSettings": [
      {
         "name": "initialValue",
         "value": "01"
      },
      {
         "name": "prefix",
         "value": "foo-"
      },
      {
         "name": "suffix",
         "value": "-bar"
      }
   ],
   "required": false
}

詳細については、 ヘッドレス API を使用したオブジェクトの管理 を参照してください。

自動増加の可用性

自動インクリメントフィールドは、Liferay DXP 2024.Q1/GA112 の リリース機能フラグ の背後でリリースされました。 これらは、2024.Q2/Portal GA120 に一般公開 (GA) されました。

Liferayのバージョン	機能のステータス	機能フラグ [ラベル]
2023年第4四半期 GA102	リリース機能	✔ [オブジェクトの自動インクリメントフィールドタイプ (LPS-196724)]
2024年第1四半期以降 GA112以降	Googleアナリティクス	✘

関連トピック

• フィールド
• 添付ファイルフィールド
• オブジェクトへのフィールドの追加
• 外部参照コードの使用