程式資訊
- 程式 ID:
USERGUIDE - 所屬子系統:A.系統資料
- 狀態:stable
線上使用手冊維護¶
功能簡介¶
「線上使用手冊維護」是系統管理員用來為每一支程式(單據別 / ProgramClass)掛載線上手冊與教學附件的設定主檔。以單據別為主檔、附件清單為明細:管理員指定一支程式代碼,再把對應的操作手冊、PDF、教學檔等掛上去;存檔時系統會把檔案上傳到後端的數位圖書館(Digital Library)統一保管。
掛上去之後,一般使用者在各程式畫面就能透過內建的「線上手冊」面板看到並開啟這些檔案——讓手冊跟著程式走,使用者不必另外找文件。
這支表單通常由 IT/系統管理員維護,屬於 A-System 系統資料 模組的基礎設定之一。
兩個入口、同一份資料
本維護表單(Userguide.xaml)是集中管理所有程式手冊的後台。一般使用者在各程式右側看到的「線上手冊」面板是唯讀檢視(內建 新增文件 鈕可就地補檔),兩者讀寫的是同一張附件清單,差別只在權限與切入點。詳見欄位連動與附加功能。
前置需求¶
- 權限:A.系統資料 →
線上使用手冊維護的瀏覽 / 新增 / 修改 / 刪除權限(依 frontmatterpermissions)。要上傳檔案需具備新增或修改權限。 - 數位圖書館路徑:存檔時檔案會被複製到後端數位圖書館目錄下的
UserGuide子資料夾(<數位圖書館目錄>\UserGuide\)。數位圖書館目錄由環境設定(ERPIO)決定,須先正確設定且可寫入,否則上傳會失敗。 - 基礎資料:
| 資料 | 影響的結果 |
|---|---|
| 程式代碼(ProgramClass / 單據別) | 主檔的單據別必須是系統中存在的程式代碼,掛上的手冊才會在該程式畫面被讀到 |
| 要掛載的檔案本身 | 明細附件——本機要先有手冊 / PDF 檔,才能透過 取得 選檔上傳 |
操作步驟¶
本表單採用標準 Ade 工具列(新增/修改/刪除/查詢/儲存/離開),以單據別為查詢與儲存的鍵。
新增一支程式的手冊¶
- 按工具列
新增。 - 在 單據別 欄輸入要掛手冊的程式代碼(例如某張單據或某支報表的 ProgramClass)。
- 在下方明細的
取得欄按下按鈕,於開檔視窗選擇本機的手冊檔案(PDF 或任意檔)。選定後檔案路徑會自動填入該列的 附件 欄。 - 要掛多份檔案時,重複在新的明細列按
取得選檔。 - 按工具列
儲存。存檔時系統會把每個附件上傳到數位圖書館,並把該列標記為已載入(載入 =Y)。
修改 / 補掛附件¶
- 先用
查詢帶出某支程式的既有手冊(以 單據別 為條件)。 - 按
修改進入編輯狀態。 - 在空白明細列按
取得補掛新檔,或調整既有列。 - 按
儲存。
刪除附件=清空附件路徑
要移除某一份手冊,把該明細列的 附件 清空再存檔即可——存檔時系統會自動把「附件為空」的列標記為刪除(不需要另外按整筆刪除)。被標記 禁止刪除 = Y 的列無法編輯/刪除。
查看(顯示)手冊¶
- 在明細列按
顯示欄的按鈕。 - 系統會用 Windows 預設關聯程式開啟該附件(例如 PDF 以 PDF 閱讀器開啟)。
- 若該列已上傳到數位圖書館(載入 =
Y),系統會先把檔案從圖書館複製到本機附件暫存區再開啟;尚未上傳的列則直接以選檔當下的本機路徑開啟。
欄位說明¶
主檔(單據別)¶
| 欄位 | 必填 | 說明/格式/預設 |
|---|---|---|
| 單據別 | ✔ | 要掛手冊的程式代碼(ProgramClass)。長度上限 60。新增時預設空白,須手動輸入。 |
| 建檔日期 | — | 建檔時自動帶入,預設空白。 |
| 工作流程 / 審核人員 / 審核日期 / 已審核 | — | 審核相關欄位,預設空白;本表單一般不需經過簽核流程即可使用。 |
明細(附件清單)¶
| 欄位 | 必填 | 說明/格式/預設 |
|---|---|---|
| 序號 | 系統 | 明細列序號,新增列時自動產生。 |
| 取得 | — | 按鈕欄。按下開啟選檔視窗,選定後把檔案路徑寫入 附件(詳見欄位連動與附加功能)。 |
| 附件 | ✔ | 手冊檔名/路徑。長度上限 180。為空白的列存檔時會被視為刪除。 |
| 載入 | 系統 | 是否已上傳數位圖書館:Y=已上傳。預設空白;存檔上傳成功後由系統填 Y。 |
| 顯示 | — | 按鈕欄。按下以預設程式開啟該附件。 |
| 路徑 | 系統 | 上傳後在數位圖書館的完整路徑,存檔時由系統回填。 |
| 禁止刪除 | 系統 | 為 Y 時該列鎖定,不可編輯/刪除。 |
| 唯一鍵 | 系統 | 上傳成功時系統產生的 GUID。 |
其他隱藏欄位
明細 Source 另有 客戶代號/廠商代號/部門代號/使用者帳號/標籤 等欄位,用於其他附件情境的分眾顯示,本維護畫面預設不顯示也不需填寫。
欄位連動與附加功能¶
這一節說明「按某顆按鈕/某欄位變動後系統會做什麼」,全部來自實際程式碼。
按 取得(選檔)¶
當你在明細列按下 取得,系統會:
- 開啟標準 Windows 開檔視窗讓你挑檔。
- 把你選到的完整檔案路徑寫入該列的 附件 欄。
- 若這一列不是新增列(增刪修不是
A),系統會把 載入 清空、並把該列標記為「修改」(增刪修=E)——代表這份附件被換過、存檔時要重新上傳。
新增列直接帶路徑、不重置載入
新增的列(增刪修=A)按 取得 只會填入附件路徑,不會去動載入狀態;要等到 儲存 才會真正上傳。
按 儲存(上傳數位圖書館)¶
存檔前,UserguideSave 會逐列檢查明細並執行:
- 附件為空的列 → 標記刪除:附件欄空白的明細列,增刪修自動改為
D,存檔時移除。 - 尚未上傳的列 → 上傳數位圖書館:對 載入 不是
Y的列,呼叫ERPIO.SaveUserGuide,把本機檔案複製到數位圖書館的UserGuide子目錄。上傳成功後系統會:- 把 附件 改成圖書館裡的新檔名;
- 把 路徑 填成圖書館完整路徑;
- 把 載入 設為
Y; - 產生並寫入一組 唯一鍵(GUID)。
存檔才會真正上傳
取得 只是在畫面上掛上本機路徑,檔案要等到按 儲存 才會被複製進數位圖書館。在存檔前關閉表單,檔案不會被保存。
按 顯示(開啟附件)¶
按 顯示 會呼叫 LibraryBll.Open 用 Windows 預設關聯程式(ShellExecute)開啟附件,並依該列是否已上傳分兩種路徑:
- 已上傳(載入=
Y):先把檔案從數位圖書館路徑複製到本機的附件暫存資料夾,再開啟本機副本。 - 未上傳:直接以選檔當下的本機路徑開啟。
開啟後的視窗定位
開啟附件時,系統會嘗試把外部程式視窗移到主螢幕右側(解析度大於 1920×1080 時),方便與 ERP 畫面並排對照。這是內建行為,不需設定。
一般使用者端的「新增文件」按鈕(線上手冊面板)¶
一般使用者在各程式看到的「線上手冊」唯讀面板,內建一顆 新增文件 按鈕(UserGuideContent / UserguideContentViewModel)。按下後系統會:
- 以目前所在程式的 ProgramClass 為 單據別。
- 開啟選檔視窗(過濾
All files (*.*)與PDF Files (*.PDF))選一份檔案。 - 查詢該程式是否已有手冊主檔:
- 尚未有 → 自動執行 Ade 新增、填入單據別與附件、直接
儲存,成功跳出「儲存成功」訊息。 - 已存在 → 自動進入修改、在附件清單末尾新增一列填入檔案、再
儲存。
- 尚未有 → 自動執行 Ade 新增、填入單據別與附件、直接
- 存檔後重新整理面板,顯示最新清單。
這讓使用者不必開後台維護表單,就能就地補掛手冊;補上的檔案與本維護表單看到的是同一份資料。
面板切換即重整
線上手冊面板每次被選取(OnSelected)都會以當前 ProgramClass 重新查詢一次,確保顯示最新手冊清單。
常見問題¶
按了 取得 選好檔,存檔後卻在別台電腦看不到?
取得 只是把本機路徑掛在畫面上,要按 儲存 才會把檔案複製進數位圖書館統一保管。確認存檔後該列的 載入 變成 Y、路徑 有填值,代表已成功上傳,其他人才看得到。若 載入 一直是空的,多半是數位圖書館目錄不存在或無寫入權限。
按 顯示 沒反應、開不了檔?
顯示 是交給 Windows 用預設關聯程式開啟。請確認:該附件對應的副檔名在本機有安裝可開啟的程式(例如 PDF 需有 PDF 閱讀器);若該列已上傳(載入=Y),還需本機能存取數位圖書館路徑以複製副本。開檔失敗時系統會跳出錯誤訊息。
想刪掉一份掛錯的手冊,找不到刪除鈕?
不需要整列刪除——把該明細列的 附件 內容清空再按 儲存 即可,存檔時系統會自動把空白附件的列標記為刪除。但若該列的 禁止刪除 為 Y,則該列被鎖定無法編輯或刪除。
為什麼有的列改不動(灰掉)?
明細列的 禁止刪除 欄為 Y 時,該列 CanEdit 會被關閉,整列鎖定不可改也不可刪。這類列通常是系統預設或受保護的手冊,請改用其他列維護。
在程式畫面按了「新增文件」,要怎麼確認掛成功?
成功時會跳出「儲存成功」訊息,面板隨即重新整理顯示新檔。若沒看到,請確認當下這支程式有正確的 ProgramClass(線上手冊面板是以當前程式代碼當 單據別),以及數位圖書館目錄可寫入。
相關功能¶
需補截圖清單
以下截圖待 runtime 驗收後補拍(放 docs/A-System/images/):
userguide-step1.png— 維護表單全貌(上方單據別 + 下方附件明細含取得/顯示兩顆按鈕)userguide-step2.png— 按取得後的選檔視窗與填入的附件路徑userguide-step3.png— 一般使用者端「線上手冊」唯讀面板與新增文件按鈕