SAP Knowledge Wiki
成果物/オブジェクト命名規約
の編集
Top
/
成果物
/
オブジェクト命名規約
-- 雛形とするページ --
(no template pages)
SAPに定義する[[リポジトリオブジェクト>SAPのオブジェクト#ref1984a]]や[[アドオン]]について規定したルール、およびそれを記述したドキュメントのこと。 ---- #contents ---- * 作成目的 [#q534e575] 検索効率の向上や可視性の保持により作業や認識の抜け漏れを防ぐことを目的とし、大きく下記の要素に分類する。 なお、実際に定義したオブジェクトは、[[オブジェクト一覧>成果物/オブジェクト一覧]]、[[モディフィケーション一覧>成果物/モディフィケーション一覧]]、[[コンフィグ定義書>成果物/コンフィグ定義書]]のいずれかに記載することで、システムに定義したオブジェクトを網羅的に把握可能とする ** 大分類 [#h9a3a6cf] 接頭子など、基本のき。 - ユーザ定義用の接頭文字 有体に言えば頭に''Z''を付与すること。これにより標準かそうでないかが明示される。 ただ、テスト用やバックアッププログラムも混ぜこぜになってしまうため、そちらには''Y''を使用した方が良いかと思う。 基本的には、ローカルオブジェクトはY始まり、開発クラスに割り当てるものはZ始まりなど明確かつシンプルなルールが好ましい。 - 業務分類コード -- システムコード 大抵は、[[財務会計]]や[[販売管理]]のようにモジュール毎に定義する。 これにより、どこのチームが主管となっているかがまる分かりになる。 -- サブシステムコード システムコードの下位構造として、コンポーネントベースで定義するのが適当かと思う。 これにより、どこのチームが主管で誰が担当しているかがまる分かりになる。 -[[パッケージ>SAPのオブジェクト/パッケージ]] 上記のシステムコードとほぼ１：１で定義される。 但し、[[SAP Note]]適用のためのものは住み分けておいた方が良いかもしれない。 ** プログラム関連 [#m3752e38] -[[アドオン]]プログラム --[[インクルード>ABAP/インクルード]] --[[モジュールプール>ABAP/モジュールプール]]（[[Dynpro>ABAP/Dynpro]]プログラムなど） ---[[モジュールプール>ABAP/モジュールプール]]の[[インクルード>ABAP/インクルード]] TOP、[[PBO>ABAP/PBO]]、[[PAI>ABAP/PAI]]、[[サブルーチン>アドオン/サブルーチン]]や[[ダイアログモジュール>ABAP/ダイアログモジュール]]ごと -[[Dynpro>ABAP/Dynpro]]番号 -[[GUIステータス>ABAP/GUIステータス]] -[[GUI表題>ABAP/GUI表題]] -[[ダイアログプログラム>ABAP/ダイアログプログラム]] -[[汎用グループ>SAPのオブジェクト/汎用グループ]] -[[汎用モジュール>SAPのオブジェクト/汎用モジュール]] -[[メッセージクラス>SAPのオブジェクト/メッセージクラス]] -[[SAP Script>SAPの拡張手段/SAP Script]] --[[フォーム名>SAPの拡張手段/SAP Script#q7d0b39d]] --[[テキストID>SAPの拡張手段/SAP Script#o66f82a1]] --[[標準テキスト>SAPの拡張手段/SAP Script#g81713ef]] --[[スタイル>SAPの拡張手段/SAP Script#n8bfc426]] -[[Smartform>SAPの拡張手段/Smartform]] --[[スタイル>SAPの拡張手段/Smartform#a646c562]] --[[テキストモジュール>SAPの拡張手段/Smartform#fa5a5b4c]] --[[フォーム本体>SAPの拡張手段/Smartform#t0e8e66e]] -[[レポートペインタ>SAPの拡張手段/レポートペインタ]] --[[レポート>SAPの拡張手段/レポートペインタ#t4505849]] --[[書式>SAPの拡張手段/レポートペインタ#p09cb5e7]] --[[ライブラリ>SAPの拡張手段/レポートペインタ#f065ebf0]] --[[モデル>SAPの拡張手段/レポートペインタ#e6e75082]] --[[変数>SAPの拡張手段/レポートペインタ#pc156fb6]] --[[標準レイアウト>SAPの拡張手段/レポートペインタ#q3cae392]] --[[ジョブ>SAPの拡張手段/レポートペインタ#d6c7264e]] -[[レポートライタ>SAPの拡張手段/レポートライタ]] --[[レポート>SAPの拡張手段/レポートライタ#t4505849]] --[[書式>SAPの拡張手段/レポートライタ#p09cb5e7]] --[[ライブラリ>SAPの拡張手段/レポートライタ#f065ebf0]] --[[モデル>SAPの拡張手段/レポートライタ#e6e75082]] --[[変数>SAPの拡張手段/レポートライタ#pc156fb6]] --[[標準レイアウト>SAPの拡張手段/レポートライタ#q3cae392]] --[[ジョブ>SAPの拡張手段/レポートライタ#d6c7264e]] -[[レイアウト>SAPの共通用語/レイアウト]](([[ALVレポート>ABAP/ALVレポート]]など)) --標準レイアウト --ユーザレイアウト -[[アプリケーションログ>ベーシス/アプリケーションログ]] --オブジェクト --サブオブジェクト -[[論理ファイル>SAPのオブジェクト/論理ファイル]] //-[[ダイアログテキスト]] -[[SAP Query>SAPの拡張手段/SAP Query]] --[[ユーザグループ>SAPの拡張手段/SAP Query#c3d3c089]] --[[インフォセット>SAPの拡張手段/SAP Query#e5aa80fe]] --[[クエリ本体>SAPの拡張手段/SAP Query#ha200ebe]] ** プログラム非関連 [#d9be0f9e] -[[テーブル>SAPのオブジェクト/テーブル]] --[[ドメイン>SAPのオブジェクト/ドメイン]] --[[データエレメント>SAPのオブジェクト/データエレメント]] --テーブル項目 --[[インデックス>SAPのオブジェクト/インデックス]] --[[構造>SAPのオブジェクト/構造]] --[[ビュー>SAPのオブジェクト/ビュー]] --[[ロックオブジェクト>SAPのオブジェクト/ロックオブジェクト]] --[[検索ヘルプ>SAPのオブジェクト/検索ヘルプ]] --[[テーブルデータ型>SAPのオブジェクト/テーブルデータ型]] -[[データ型グループ>SAPのオブジェクト/データ型グループ]] -[[バリアント>SAPのオブジェクト/バリアント]] --一般的な[[バリアント>SAPのオブジェクト/バリアント]] --[[システムバリアント>SAPのオブジェクト/システムバリアント]] --[[バリアント変数>SAPのオブジェクト/バリアント変数]] -[[ユーザパラメータ>SAPの共通用語/ユーザパラメータ]] -[[トランザクションコード>SAPのオブジェクト/トランザクションコード]] -[[権限>権限管理]] --[[権限クラス>権限管理/権限クラス]] --[[権限オブジェクト>権限管理/権限オブジェクト]] --[[権限項目>権限管理/権限項目]] --[[権限プロファイル>権限管理/権限プロファイル]]（[[権限ロール>権限管理/権限ロール]]から生成しない場合） -[[番号範囲オブジェクト>SAPのオブジェクト/番号範囲オブジェクト]] -[[カスタマExitのプロジェクト>SAPの拡張手段#gbddf2c4]] -[[外部コマンド>ベーシス/外部コマンド]] -[[システムイベント>SAPの共通用語/システムイベント]] -[[セット>SAPの共通用語/セット]] * 作成単位 [#tebcb1e8] 分けるメリットは皆無なので、[[システムランドスケープ>SAPの構成/システムランドスケープ]]でひとつ。 複数のSAPを導入している企業においては、基本的には[[システムランドスケープ>SAPの構成/システムランドスケープ]]が分かれている限りはオブジェクト名が重複していようがどうでもよいといえばよいのだが、同じオブジェクト名・・・例えば同じプログラムIDやテーブル名なのにシステムごとに意味が違うなんて美しくないわけだから、システム共通だとgoodかと思う。 * 作成担当 [#oa1e41fd] 会社自身が持っている規約をまんま踏襲する場合や顧客に何らかの機能が導入済みの場合は乗っかるというケースもあるが、[[プロジェクト]]で作成する場合は開発チームリードなんかで良いと思う。 * 作成タイミング [#w3667485] 実現化フェーズ開始前まで。 * 更新ルール [#ye1d7f1a] 抜け漏れや誤りが無い限りは、基本的には更新しないかと思う。 しいて言えば、モジュールやコンポーネントの追加導入などを行う場合。 ~ ~ CENTER:【スポンサードリンク】 #htmlinsert(amazon_book_sap_system_implement) ~ ~ ---- #pcomment(reply)
タイムスタンプを変更しない
SAPに定義する[[リポジトリオブジェクト>SAPのオブジェクト#ref1984a]]や[[アドオン]]について規定したルール、およびそれを記述したドキュメントのこと。 ---- #contents ---- * 作成目的 [#q534e575] 検索効率の向上や可視性の保持により作業や認識の抜け漏れを防ぐことを目的とし、大きく下記の要素に分類する。 なお、実際に定義したオブジェクトは、[[オブジェクト一覧>成果物/オブジェクト一覧]]、[[モディフィケーション一覧>成果物/モディフィケーション一覧]]、[[コンフィグ定義書>成果物/コンフィグ定義書]]のいずれかに記載することで、システムに定義したオブジェクトを網羅的に把握可能とする ** 大分類 [#h9a3a6cf] 接頭子など、基本のき。 - ユーザ定義用の接頭文字 有体に言えば頭に''Z''を付与すること。これにより標準かそうでないかが明示される。 ただ、テスト用やバックアッププログラムも混ぜこぜになってしまうため、そちらには''Y''を使用した方が良いかと思う。 基本的には、ローカルオブジェクトはY始まり、開発クラスに割り当てるものはZ始まりなど明確かつシンプルなルールが好ましい。 - 業務分類コード -- システムコード 大抵は、[[財務会計]]や[[販売管理]]のようにモジュール毎に定義する。 これにより、どこのチームが主管となっているかがまる分かりになる。 -- サブシステムコード システムコードの下位構造として、コンポーネントベースで定義するのが適当かと思う。 これにより、どこのチームが主管で誰が担当しているかがまる分かりになる。 -[[パッケージ>SAPのオブジェクト/パッケージ]] 上記のシステムコードとほぼ１：１で定義される。 但し、[[SAP Note]]適用のためのものは住み分けておいた方が良いかもしれない。 ** プログラム関連 [#m3752e38] -[[アドオン]]プログラム --[[インクルード>ABAP/インクルード]] --[[モジュールプール>ABAP/モジュールプール]]（[[Dynpro>ABAP/Dynpro]]プログラムなど） ---[[モジュールプール>ABAP/モジュールプール]]の[[インクルード>ABAP/インクルード]] TOP、[[PBO>ABAP/PBO]]、[[PAI>ABAP/PAI]]、[[サブルーチン>アドオン/サブルーチン]]や[[ダイアログモジュール>ABAP/ダイアログモジュール]]ごと -[[Dynpro>ABAP/Dynpro]]番号 -[[GUIステータス>ABAP/GUIステータス]] -[[GUI表題>ABAP/GUI表題]] -[[ダイアログプログラム>ABAP/ダイアログプログラム]] -[[汎用グループ>SAPのオブジェクト/汎用グループ]] -[[汎用モジュール>SAPのオブジェクト/汎用モジュール]] -[[メッセージクラス>SAPのオブジェクト/メッセージクラス]] -[[SAP Script>SAPの拡張手段/SAP Script]] --[[フォーム名>SAPの拡張手段/SAP Script#q7d0b39d]] --[[テキストID>SAPの拡張手段/SAP Script#o66f82a1]] --[[標準テキスト>SAPの拡張手段/SAP Script#g81713ef]] --[[スタイル>SAPの拡張手段/SAP Script#n8bfc426]] -[[Smartform>SAPの拡張手段/Smartform]] --[[スタイル>SAPの拡張手段/Smartform#a646c562]] --[[テキストモジュール>SAPの拡張手段/Smartform#fa5a5b4c]] --[[フォーム本体>SAPの拡張手段/Smartform#t0e8e66e]] -[[レポートペインタ>SAPの拡張手段/レポートペインタ]] --[[レポート>SAPの拡張手段/レポートペインタ#t4505849]] --[[書式>SAPの拡張手段/レポートペインタ#p09cb5e7]] --[[ライブラリ>SAPの拡張手段/レポートペインタ#f065ebf0]] --[[モデル>SAPの拡張手段/レポートペインタ#e6e75082]] --[[変数>SAPの拡張手段/レポートペインタ#pc156fb6]] --[[標準レイアウト>SAPの拡張手段/レポートペインタ#q3cae392]] --[[ジョブ>SAPの拡張手段/レポートペインタ#d6c7264e]] -[[レポートライタ>SAPの拡張手段/レポートライタ]] --[[レポート>SAPの拡張手段/レポートライタ#t4505849]] --[[書式>SAPの拡張手段/レポートライタ#p09cb5e7]] --[[ライブラリ>SAPの拡張手段/レポートライタ#f065ebf0]] --[[モデル>SAPの拡張手段/レポートライタ#e6e75082]] --[[変数>SAPの拡張手段/レポートライタ#pc156fb6]] --[[標準レイアウト>SAPの拡張手段/レポートライタ#q3cae392]] --[[ジョブ>SAPの拡張手段/レポートライタ#d6c7264e]] -[[レイアウト>SAPの共通用語/レイアウト]](([[ALVレポート>ABAP/ALVレポート]]など)) --標準レイアウト --ユーザレイアウト -[[アプリケーションログ>ベーシス/アプリケーションログ]] --オブジェクト --サブオブジェクト -[[論理ファイル>SAPのオブジェクト/論理ファイル]] //-[[ダイアログテキスト]] -[[SAP Query>SAPの拡張手段/SAP Query]] --[[ユーザグループ>SAPの拡張手段/SAP Query#c3d3c089]] --[[インフォセット>SAPの拡張手段/SAP Query#e5aa80fe]] --[[クエリ本体>SAPの拡張手段/SAP Query#ha200ebe]] ** プログラム非関連 [#d9be0f9e] -[[テーブル>SAPのオブジェクト/テーブル]] --[[ドメイン>SAPのオブジェクト/ドメイン]] --[[データエレメント>SAPのオブジェクト/データエレメント]] --テーブル項目 --[[インデックス>SAPのオブジェクト/インデックス]] --[[構造>SAPのオブジェクト/構造]] --[[ビュー>SAPのオブジェクト/ビュー]] --[[ロックオブジェクト>SAPのオブジェクト/ロックオブジェクト]] --[[検索ヘルプ>SAPのオブジェクト/検索ヘルプ]] --[[テーブルデータ型>SAPのオブジェクト/テーブルデータ型]] -[[データ型グループ>SAPのオブジェクト/データ型グループ]] -[[バリアント>SAPのオブジェクト/バリアント]] --一般的な[[バリアント>SAPのオブジェクト/バリアント]] --[[システムバリアント>SAPのオブジェクト/システムバリアント]] --[[バリアント変数>SAPのオブジェクト/バリアント変数]] -[[ユーザパラメータ>SAPの共通用語/ユーザパラメータ]] -[[トランザクションコード>SAPのオブジェクト/トランザクションコード]] -[[権限>権限管理]] --[[権限クラス>権限管理/権限クラス]] --[[権限オブジェクト>権限管理/権限オブジェクト]] --[[権限項目>権限管理/権限項目]] --[[権限プロファイル>権限管理/権限プロファイル]]（[[権限ロール>権限管理/権限ロール]]から生成しない場合） -[[番号範囲オブジェクト>SAPのオブジェクト/番号範囲オブジェクト]] -[[カスタマExitのプロジェクト>SAPの拡張手段#gbddf2c4]] -[[外部コマンド>ベーシス/外部コマンド]] -[[システムイベント>SAPの共通用語/システムイベント]] -[[セット>SAPの共通用語/セット]] * 作成単位 [#tebcb1e8] 分けるメリットは皆無なので、[[システムランドスケープ>SAPの構成/システムランドスケープ]]でひとつ。 複数のSAPを導入している企業においては、基本的には[[システムランドスケープ>SAPの構成/システムランドスケープ]]が分かれている限りはオブジェクト名が重複していようがどうでもよいといえばよいのだが、同じオブジェクト名・・・例えば同じプログラムIDやテーブル名なのにシステムごとに意味が違うなんて美しくないわけだから、システム共通だとgoodかと思う。 * 作成担当 [#oa1e41fd] 会社自身が持っている規約をまんま踏襲する場合や顧客に何らかの機能が導入済みの場合は乗っかるというケースもあるが、[[プロジェクト]]で作成する場合は開発チームリードなんかで良いと思う。 * 作成タイミング [#w3667485] 実現化フェーズ開始前まで。 * 更新ルール [#ye1d7f1a] 抜け漏れや誤りが無い限りは、基本的には更新しないかと思う。 しいて言えば、モジュールやコンポーネントの追加導入などを行う場合。 ~ ~ CENTER:【スポンサードリンク】 #htmlinsert(amazon_book_sap_system_implement) ~ ~ ---- #pcomment(reply)
テキスト整形のルールを表示する
