Accel Studio アプリケーション管理機能 仕様書 第6版 2024-04-01

4.9.1. 自動採番

自動採番は、採番定義を管理する機能、連番値を管理する採番簿から採番を取得する機能と連番値を変更する機能を提供します。

コラム

自動採番は2023 Autumn(Hollyhock)より追加されました。

4.9.1.1. 採番定義が扱う情報

採番定義は下記の情報を管理します。

  • 採番定義ID
    • 採番定義を一意に識別するためのIDです。
  • 採番定義名
    • 採番定義の名前です。
  • 説明
    • 採番定義の内容に関する説明です。
  • 採番定義カテゴリ
    • 採番定義を分類するカテゴリです。
  • 採番形式
    • 採番の形式の設定です。
  • 採番リセットスケジュール
    • 採番の形式の設定です。
  • 現在の連番
    • 採番の現在の連番に関する設定です。

4.9.1.2. 国際化

採番定義の名称と説明は、各ロケール用(製品標準では、日本語、英語、中国語)の表示名と標準表示名を持ちます。
原則として採番定義管理機能では、ユーザのロケールに合わせた表示名を利用します。
対象のユーザのロケールに合致する表示名が定義されていない場合、採番定義管理機能はその代替として標準表示名を利用します。
採番定義カテゴリについても同様です。

4.9.1.3. 採番定義カテゴリ

採番定義カテゴリは、採番定義の利用用途や適用範囲を分類するための情報です。
採番定義管理機能では採番定義の管理・分類するための情報として採番定義カテゴリを利用します。

4.9.1.4. 採番定義カテゴリが扱う情報

採番定義カテゴリは下記の情報を管理します。

  • カテゴリID
    • カテゴリを一意に識別するためのIDです。
  • カテゴリ名
    • カテゴリの名前です。
  • 親カテゴリID
    • 親カテゴリのカテゴリIDです。
  • ソート番号
    • カテゴリの表示順を制御するための番号です。

4.9.1.5. カテゴリの階層化

採番定義カテゴリは階層構造を設定できます。
採番定義カテゴリに親カテゴリを設定することで、設定したカテゴリの子カテゴリとして設定され、階層構造を持ちます。

4.9.1.6. カテゴリの削除

採番定義カテゴリの削除には、物理削除が利用されます。
また採番定義カテゴリは、下記の条件の場合のみ削除可能です。
  • 削除対象のカテゴリの属する採番定義が存在しない場合
  • 削除対象のカテゴリに子カテゴリが存在しない場合

4.9.1.7. 採番形式

採番形式は、採番要素を組み合わせ、採番の書式を設定する項目です。

採番要素は下記の項目を提供します。

  • 連番
    • 当該要素は1つ設定できます。
    • 開始番号、表示桁数、増分値が設定できます。
  • 文字列
    • 当該要素は複数設定できます。
    • 任意の文字を設定できます。
  • 区切り文字
    • 当該要素は複数設定できます。
    • -(ハイフン)、_(アンダースコア)、/(スラッシュ)、.(ドット)から選択できます。
  • 日付形式
    • 当該要素は複数設定できます。
    • yyyy/MM/dd、yy/MM/dd、yyyy/MM、yy/MM、MM、ddから選択できます。
  • 年度
    • 当該要素は複数設定できます。
    • 開始月
      • 年度の開始する月を設定できます。
    • 年度の種類
      • 西暦、和暦から選択できます。
    • 形式
      • yyyy、yyから選択できます。

4.9.1.8. 採番リセットスケジュール

採番リセットスケジュールは、採番簿から採番を取得した際に、採番簿の連番の値を初期化する設定です。

  • 採番リセット周期
    • 設定する、設定しないから選択できます。
    • 設定しない場合は、採番簿から採番を取得した際に、採番簿の連番の値を初期化しません。
  • 繰り返し
    • 採番リセット周期が設定するの場合、毎年、毎月、毎日から選択できます。
    • 採番リセット周期が設定する、繰り返しが毎年の場合、月を設定できます。
    • 採番リセット周期が設定する、繰り返しが毎年または毎月の場合、日を設定できます。

コラム

採番簿の連番の値を初期化する契機について

当該設定において、採番リセット周期を設定する、という設定を行った場合、採番形式に日付形式、年度の有無に関係なく、採番簿から採番を取得する内部処理で採番簿の連番の値を初期化します。
取得する採番が重複しないよう設計してください。
また、初期化する日付の判定は、システム日時点を基準として、時間は 00:00:00 として判定します。

コラム

存在しない日を設定した場合

当該設定において、採番リセット周期を設定する、かつ、存在しない日を設定した場合、採番簿から採番を取得する内部処理では、当月の末日として取り扱います。
例えば、繰り返しに「毎月」、日に「31」と設定した場合、1月の場合は31日で処理しますが、4月の場合は30日で処理します。

4.9.1.9. 現在の連番

採番簿で管理する連番の値を管理します。

  • 現在番号
    • 採番簿で管理する連番の値を表示します。
  • 現在番号の変更
    • 採番簿で管理する連番の値を変更します。

4.9.1.10. 採番定義の操作

  • 作成
    • 採番定義の作成ができます。
      • 採番定義ID
      • 採番定義名
      • 説明
      • 採番定義カテゴリ
      • 採番形式
      • 採番リセットスケジュール

コラム

作成時に設定できない項目

作成時には 現在の番号 は設定できません。
採番簿は作成されません。

コラム

採番簿が作成されるタイミング

採番定義を作成した後、採番簿から採番を初めて取得したときに、採番簿が作成されます。
  • 更新
    • 採番定義の更新ができます。
      • 採番定義名
      • 説明
      • 採番定義カテゴリ
      • 採番形式
      • 採番リセットスケジュール
      • 現在の連番

コラム

更新時に変更できない項目

更新時には 採番定義ID , 採番形式の連番の開始番号 は変更できません。

注意

更新した後、取得する採番に影響がある項目

採番形式の採番要素
採番が生成済みの場合、採番形式設定を変更すると次回から生成済みの採番と異なる形式の採番が生成されます。

採番形式の連番の表示桁数
表示桁数を減らすと生成できる採番の個数が減ります。生成できる採番の上限を超えると採番が生成できません。

採番形式の連番の増分値
増分値を増やすと生成できる採番の個数が減ります。 生成できる採番の上限を超えると採番が生成できません。

採番リセットスケジュール
以下の変更を行った場合、採番簿が削除されます。管理していた連番の値も削除されます。
採番リセット周期を設定する/しないの変更
繰り返しの毎年/毎月/毎日の変更
月/日の変更
  • コピー新規
    • 当該採番定義の情報を複製して、新たに採番定義を作成できます。
    • 複製する情報は以下の通りです。
      • 採番定義名
      • 説明
      • 採番定義カテゴリ
      • 採番形式
      • 採番リセットスケジュール

コラム

アプリケーションのリソースとして管理されている採番定義の場合

コピー新規した採番定義はアプリケーションのリソースには含まれません。
作成時に戻る、または作成後は採番定義一覧へ遷移します。
  • 削除
    • 採番定義の削除ができます。
    • 採番簿の削除ができます。

4.9.1.11. 採番の取得

採番簿から採番を取得します。

4.9.1.12. 採番のリセット

採番簿の連番の値を設定します。

4.9.1.13. 採番定義一覧

採番定義の一覧を参照できます。
カテゴリの登録、更新、削除ができます。

コラム

採番定義一覧へのアクセス

採番定義一覧は2024 Spring(Iris)でサイトマップ、グローバルメニューを提供しました。

2023 Autumn(Hollyhock)時点ではサイトマップ、グローバルメニューは提供しておりません。
採番定義一覧を利用する場合は、以下のURLからアクセスしてください。

http://<HOST>:<PORT>/<CONTEXT_PATH>/lowcode_utilities/autonumbering/list

4.9.1.14. インポート・エクスポートで扱う情報

インポート・エクスポートでは以下の情報を扱います。

4.9.1.15. インポート・エクスポート時の動作仕様

採番定義のインポート・エクスポート機能の動作仕様は、以下の通りです。
  • エクスポート

    • エクスポート機能は、 「インポート・エクスポートで扱う情報」 に記載した内容を出力します。
      採番定義カテゴリは、採番定義が分類されているカテゴリと、その親カテゴリ全てが出力対象です。
  • インポート

    • インポート機能は、エクスポート機能により、出力された json ファイルをもとに、ファイルに含まれる全ての採番定義と採番定義カテゴリに関するデータを取り込みます。
      採番定義と採番定義カテゴリは、存在していなければ新規作成、存在していた場合は更新処理が行われます。

コラム

採番定義 インポート、採番定義 エクスポートへのアクセス

採番定義 インポート 、採番定義 エクスポートは2024 Spring(Iris)でサイトマップ、グローバルメニューを提供しています。
採番定義一覧より遷移することも可能です。