二、TIPTOP命名原則和目錄配置—TIPTOP GP ERP二次開發新手教程

標籤：tiptop   二次開發   易拓   新手教程   

命名原則系統命名原則

系統以三至四個英文字母來命名，第一碼為標準或客制的識別碼，後面幾碼為有意義的英文縮寫。

（系統代號）格式：

AXX 標準系統模組
GXX 配合兩岸三地相關規則調整的模組
CXX 客制（客戶定製）化模組

說明：

XX為系統英文縮寫代碼

例子：

AIM 料件主檔（Item Master）、庫存(Inventory Management)管理系統
ASM 系統基本資料管理（System Management）

程式（程式）命名原則

1、主要檔名

格式：

SSSP999

說明：

SSS為系統代號（要以小寫字母表示）
P為程式類型

i       維護作業        r       報表作業m       目錄選單        s       參數設定p       批次處理        t       交易處理q       查詢作業        u       協助工具輔助

999為作業代碼

• 在使用作業代碼時，第一碼錶示處理階段，如：０表示參數設定、１表示基本資料的維護。第二、三碼為流水號。
• 如果在程式中，包含了一個以上的副函式或者子畫面，則可以在加上第四碼來表示歸屬於該主程式下的附屬資料（畫面或程式）。

舉例：

aimi100：

aim：料件主檔系統代號
i:作業類型為維護作業
100：作業代碼

aimi1001(作業程式碼封裝括第四碼):這個程式名表示程式aimi100的子檔案

列外：

比如在AZZ系統管理代號，程式命名原則就不按照此方式進行。
命名原則：依照[程式使用設定檔名稱]或者[程式用途兩個方面來進行命名]

2、附加檔名

附加設定檔名稱分為三類：4gl原始程式部分、畫面格式、其他格式

(1).4gl原始程式部分

4gl:原始程式
42m:原始程式編譯後的目標程式
42r:串連後可啟動並執行目標程式

(2).畫面格式

4fd:Form Designer使用的畫面檔
per:透過gsform工具將4fd檔案轉換成畫面對照檔
42f:編譯完成的畫面檔案資料

(3).其他格式

sch:檔案參考內容
rep:

共用程式（程式）命名原則

共用程式為在TIPTOP GP中可全系統通用的函式，子程式為只有部分子系統可以使用的函式。

格式：

cl_XXXXXXX

說明：

cl_：表示該程式為共用程式（Common Library）
XXXXXXX：最少一個字元，最多17個字元（因為各維護作業錄入限制）。命名必須有代表意義，可以加上“_”來區隔。

舉例：

cl_err：用來顯示錯誤資訊
cl_null：檢查輸入的值是否為空白

共用程式存放的位置：

放置在TIPTOP GP系統中的$TOP/lib目錄下，依副檔名的不同分類歸放。

子程式命名原則

子程式：

指在程式開發中，一併會將限定在部分程式中，將共同使用的函式獨立出來，另外寫成一段程式。

子程式的特性：

容易維護、正確、節省開發時間。

子程式分類：

• 一般子程式；
• 查詢子程式；

1、一般子程式

格式：

s_XXXXXXX

說明：

s_：表示該程式為一般用途子程式（Subfunction)
XXXXXXX:最多18個字元，最少1個字元。需以有意義的方式命名。如：英文縮寫等。

舉例：

s_upimg為庫存系統中，更新img_file的子程式。

一般子程式存放的位置：

放置於TIPTOP GP系統中的$TOP/sub目錄下，依據副檔名不同分類歸放。

2、查詢子程式

格式：

q_XXXXXXX

說明：

q_：表示該程式為查詢類（Query)子程式
XXXXXXX：最多18個字元，最少1個字元。需以有意義的方式命名，多半以欲查詢的資料庫表格（table name）名稱命名。
注意：如果該資料庫表格名稱已被使用，則可以在後面加流水號，辨識前後順序的不同。

舉例：

q_ima為料件資料查詢
查詢子程式存放的位置：
放置於TIPTOP GP系統中的$TOP/qry目錄下，依副檔名不同分類歸放。

注意：

查詢子程式命名不能與【動態查詢子程式】名稱衝突，若名字上有衝突，則後續登入資料或者進行系統管理時，會有不可預期的困難和錯誤情形發生

實際操作指導：

編寫簡單的查詢子程式建議不要自行撰寫程式，可參照【AZZ系統管理】模組中隊【p_qry】的介紹。自行定義【動態查詢子程式】，填寫完相關欲查詢的表格、欄位資料後即可使用，較自行撰寫查詢子程式簡易，於後續管理上也較方便。

3、一般子程式和共用程式的差別

相同點：

• 多個程式共同使用的特性；
• 具有易維護、正確、節省開發時間的特性；

不同點：

• 共用程式【cl_XXXXXXX】每個子系統（模組）皆可適用；
• 一般子程式【s_XXXXXXX】只針對某個或者某幾個子系統（模組）；

函數命名原則

函數（functioin)：

在程式中，具有獨立的性質，而且能夠提供特殊功能的部分組成。

格式：

XXXX_yy

說明：

XXXX_:為程式碼簡稱，多與系統（模組)代號後的4碼錶示
yy：為該函數的功能說明

舉例：

i100_a為該作業的新增函數

程式中包含以下函數功能：

注意：

在同一個主程式名稱下，不可使用相同的函數名稱，以避免程式於連結或在運行階段發生不可預期的錯誤。

變數命名原則

依照變數在程式中出現和使用的特性，可以將變數分為總體性變數、地區變數、傳遞參數及螢幕變數。

1、整體性變數（Global Varibles)

格式：

g_XXXXXXX

說明：

g_：表示該變數具有整體性（Gobal)

XXXXXXX:為變數的名稱

舉例：

g_gui_type為定義gui的樣式為哪一種

整體性變數定義的位置：

整體性變數定義在整體性變數檔案中，該檔案為$top/config/top.global。

2、地區性變數（Local Varible)

格式：

l_XXXXXXX

說明：

l_：表示該變數具有地區性（Local），僅限與某Function中有效。
XXXXXXX：為有意義的名稱，請以有意義的方式命名。

3、傳遞性參數（Parameter Varlables)

格式：

p_XXXXXXX

說明：

p_：表示該變數具有傳遞性（parameter)
XXXXXXX：為變數名稱，請以有意義之方式命名。

4、螢幕變數（Screen Varlables)

格式：

s_XXXXXXX

說明：

s_:表示該變數為螢幕變數（Screen)
XXXXXXX:為變數名稱，請以有意義的方式命名。

使用範圍：

在單檔多欄中會使用到螢幕變數（Screen varlables）

注意：

螢幕變數（Screen)以欄位來命名，以方便和欄位做對比。而且，只有使用多欄式數組的程式才需以此方式定義。

資料庫表格命名原則

表格命名長度以3至4個英文字元命名，不同的系統，配置了不同的表格名稱使用區段，建議在開啟新的表格前，先行瞭解系統原始啟動的表格名稱範圍。

1、表格名稱（Table Name)

格式：

XXX_file

客制（客戶定製）表格命名格式：

tc_XXX_file

說明：

XXX:用2碼至4碼錶示，以小寫英文字元（可含數字）命名。
_file:固定字，表示為表格。

舉例：

aim_file為料件主檔
gef_file為銷售單據性質檔

注意：

在開啟新表格前，須在【p_zta檔案架構修整記錄維護作業】中註冊該支表格的相關資料及使用方法，始納入管理。

2、欄位名稱（Field Name)

格式：

XXX99

客制（客戶定製）欄位命名格式：

(1).在客製表格中添加客制欄位的命名原則：

格式：

tc_XXX99

舉例：

tc_ima_file下的客制欄位為：tc_ima001、tc_ima002….。

(2).在標準表格中添加客制欄位的命名原則：

格式：

ta_XXX99

舉例：

ima_file下的客制欄位為：ta_ima001、ta_ima002…。

說明：

XXX：與表格名稱XXX_file的XXX名稱一致。
99：為2碼流水編號，如果流水號不足可以擴充為3至4碼。

舉例：

zz32為表格zz_file中的欄位。

注意：

在開啟新欄位前，須在【p_zta檔案架構修整記錄維護作業】中註冊該支表格的相關資料及使用方法，始納入管理。

3、索引名稱（Index Name)

格式：

XXX_01

客制（客戶定製）索引命名格式：

tic_XXX_01

舉例：

ima_file表格下的客制索引為tic_ima_01。

說明：

XXX:與表格名稱XXX_file的XXX名稱一致。
01：為2碼流水編號。

舉例：

zz_01為在zz_file的UNIQUE INDEX代碼。

注意：

在開啟新索引前，須在【p_zta檔案架構修整記錄維護作業】中註冊該支表格的相關資料及使用方法，始納入管理。

4、存放TIPTOP系統中存放的Schema檔案（Sch Files)

格式：

XXX_file.sch

說明：

此為表格存在系統中設定檔名稱
XXX:與表格名稱XXX_file的XXX名稱一致。

例子：

ima_file.sch為料件主檔的Schema設定檔名稱。

目錄配置

1、TIPTOP目錄配置

2、Config目錄配置

參考文獻下載：http://download.csdn.net/download/wahaa591/8796431

二、TIPTOP命名原則和目錄配置—TIPTOP GP ERP二次開發新手教程