悅享版檔案上傳下載插件

1.1 版本

1.2 應用場景

使用者透過報表對檔案上傳下載

1.3 功能介紹

1）上傳檔案

• 報表填報屬性介面，自訂提交中新增上傳類型選擇悅享版檔案上傳

• 支援按鈕或者其他元件的事件進行檔案上傳

• 支援多檔案上傳

• 支援大檔案下載

• 行動端僅支援上傳圖片檔案

2）下載檔案

• 超級連結新增一個連結類型 悅享版檔案下載

• 支援按鈕或者其他元件的事件進行檔案下載

• 支援多檔案下載

• 支援大檔案上傳

• 支援APP檔案下載

• 支援H5檔案下載

• 支援填報動態計算檔案下載

• 支援預覽圖片

3）檔案類型

• 伺服器本地目錄

• FTP

• SFTP

• AWS S3(亞馬遜S3)，包括阿里雲OSS、騰訊雲COS、華為雲OBS、MinIO等支援相容AWS S3API的儲存服務

• 阿里雲OSS

• 華為雲OBS

需要給出如下詳細的範本設計步驟，如果不需要範例範本，需要改成詳細的操作步驟

2.1 插件安裝

點選下載插件：悅享版檔案上傳下載插件

伺服器-設計器插件安裝方法請參見：伺服器-設計器插件管理

2.2 操作說明

2.2.1 連結設定

只針對非伺服器本地目錄設定。

在報表填報屬性介面，點選如下圖所示的按鈕，選擇菜單即可。或者在設計器的伺服器選單下點選悅享版上傳下載連結資訊選單

1）FTP/SFTP配置介面

• 按標簽說明，填寫配置參數，填完後點選測試連結按鈕，測試能否正常連結

FTP伺服器為windows工件系統時,編碼可能為GBK，若無法連結或上傳下載檔案報錯,可以將編碼改為GBK

2）S3協定配置介面

• 若儲存空間(Bucket)存在多個，用逗號隔開填入即可

• 按標簽說明，填寫配置參數，填完後點選測試連結按鈕，測試能否正常連結

• 地域一般預設不填，不做校驗

2.2.2 檔案上傳

1）填報自訂提交

在普通報表編輯狀態下，點選選單 範本->報表填報屬性 介面，如下圖所示：

• 位置1 新增自訂提交

• 位置2 選擇提交型別選擇悅享版檔案上傳

• 位置3 設定連結型別

• 位置4 設定是否對重複檔案改寫

• 位置5 設定上傳檔案參數，支援字串和公式

                  上傳目錄為檔案要上傳的路徑，為絕對路徑

                 針對不同檔案後綴，上傳不同的目錄 ，可以寫成 後綴>目錄，多目錄用豎線隔開，若設定重複以最後設定的後綴對應的目錄為準

                 例如 D:/test2|xls,ppt>D:/test|doc,xlsx,xls>D:/test1      xls,ppt後綴的檔案上傳到D:/test目錄，doc,xlsx,xls上傳到D:/test1目錄，其他的上傳到D:/test2目錄

                  檔案名稱為上傳檔案名稱，若為空，則預設為上傳檔案的原始檔案名稱

                  檔案為檔案元件所在的位置，請參考檔案元件簡介

2）按鈕或者其他元件的事件

此功能目前只支援填報報表和決策報表(即能夠使用檔案元件的報表)。

選擇元件的事件欄，新增事件，選擇點選事件，位置2下拉列表中選擇悅享版檔案上傳即可。

注意：

•  檔案列中的公式必須是檔案元件的參數或者是放置檔案元件的儲存格 

•  上傳事件不支援儲存格擴展場景

2.2.3 檔案下載

1）超級連結

選擇報表儲存格的超級連結，新增連結選擇悅享版檔案下載

• 位置1 將位置4的配置增加到中間表格列表中

• 位置2 在表格中選擇配置，將位置4的配置修改選中的配置

• 位置3 刪除表格中選中的配置
  

• 位置4 設定檔案下載目錄，為絕對路徑，支援字串和公式；設定下載檔案名稱，支援字串和公式，多個檔案名稱用雙豎線隔開，就可以下載多個檔案

• 位置5 若讓多個 檔案打包壓縮成一個檔案下載，請勾選下圖選項<多個檔案打包壓縮成一個檔案>

• 位置6 下載檔案的重命名

注：行動端不支援多個檔案時，每個檔案單獨下載

2）按鈕或者其他元件的事件

選擇元件的事件欄，新增事件，選擇點選事件，位置2下拉列表中選擇悅享版檔案下載即可。

提示:不推薦在APP端的參數元件裏面新增下載事件，體驗不太好，可以在APP端的報表內容中的元件新增事件 

2.2.4 函式

1、DELIGHT_IMAGE :傳回悅享版連結的圖片。

DELIGHT_IMAGE(serverName,directory,fileName,bucket,cacheOption)

• serverName  連結名稱,若為空,則為伺服器本地目錄,必填;

• directory  檔案目錄,必填;

• fileName  檔案名稱,必填;

• bucket  S3的儲存空間(Bucket),非必填

• cacheOption  是否在瀏覽器裏快取圖片，預設是快取圖片，若不想快取圖片,值為false,非必填

• imageLayout  圖片佈局，0:預設;1:平鋪;2:拉伸;3:適應;非必填,若沒有設定則使用儲存格的圖片佈局

此函式用在儲存格時，沒有設定imageLayout時,顯示圖片的佈局與<儲存格屬性>-<樣式>-<圖片佈局>設定一緻，如下圖所示：

提示：若設定<儲存格屬性>-<樣式>-<圖片佈局>不生效，則使用imageLayout參數設定圖片佈局

例如:

1)用函式顯示伺服器本地圖片

DELIGHT_IMAGE("","E:/test","demo.png")

2)用函式顯示FTP/SFTP伺服器圖片

DELIGHT_IMAGE("ftp1","/home/test","demo.png")

3)用函式顯示S3伺服器圖片

DELIGHT_IMAGE("oss","/home/test","demo.png","oss-build")

4)用函式顯示伺服器本地圖片,在瀏覽器中不快取圖片

DELIGHT_IMAGE("","E:/test","demo.png","",false)

5)用函式顯示伺服器本地圖片,在瀏覽器中不快取圖片,圖片佈局為拉伸

DELIGHT_IMAGE("","E:/test","demo.png","",false,2)

2、DELIGHT_FILE_EXISTS :判斷檔案是否存在,若存在則傳回1,否則傳回0

DELIGHT_FILE_EXISTS (serverName,directory,fileName,bucket)

• serverName  連結名稱,若為空,則為伺服器本地目錄,必填;

• directory  檔案目錄,必填;

• fileName  檔案名稱,必填;

• bucket  S3的儲存空間(Bucket),非必填

例如:

1)用函式判斷伺服器本地檔案是否存在

DELIGHT_FILE_EXISTS("","E:/test","demo.png")

2)用函式判斷FTP/SFTP伺服器檔案是否存在

DELIGHT_FILE_EXISTS("ftp1","/home/test","demo.png")

3)用函式判斷S3伺服器檔案是否存在

DELIGHT_FILE_EXISTS("oss","/home/test","demo.png","oss-build")

2.2.4 檔案元件

在報表儲存格，新增一個<悅享版檔案元件>,支援自訂檔案型別，若自訂多個檔案型別，用豎線(|)隔開,如下圖所示：

若<自訂的檔案型別>在預定義的<檔案型別>中，則預設顯示在預定義的<檔案型別>中

檔案上傳支援多個檔案一起上傳

檔案下載不支援目錄下載

檔案上傳,若檔案資料夾不存在,會自動建立資料夾

在<事件>裏面,上傳檔案時，檔案名稱不支援擴展儲存格

容器化環境上傳檔案給主機，需要做容器和主機之間的上傳路徑檔案映射

1.針對檔案上傳檔案名稱設定

1).若檔案名稱為空，則使用檔案的原始檔案名稱

2).若檔案名稱沒有後綴，則會在檔案名稱上新增原始檔案名稱後綴

3).檔案名稱支援函式，用參數$delight_upload_original_file_name表示原始檔案名稱,參與函式計算

4).對於多檔案上傳,檔案名稱設定

  4.1).檔案名稱為為空，使用原始檔案名稱

  4.2).用函式動態生成檔案名稱,比如UUID函式

  4.3).用陣列，可以用函式SPLIT生成陣列或者用函式FILENAME生成原始檔案名稱的陣列

         這樣，可以保證檔案名稱是多個且不重複

2.檔案上傳的檔案設定

檔案用的公式必須是檔案元件的參數或者放置檔案元件的儲存格，目前只有填報報表和決策報表支援檔案上傳

檔案元件名作為的參數使用只支援決策報表

3.對於IIS搭建的FTP伺服器,在設定伺服器連結時，建議將編碼設定為GBK

4.自動建立資料夾，以及上傳下載都需要有資料夾權限

5.上傳下載伺服器本地目錄,目錄是絕對路徑

6.ftp在windows上是相對路徑,在Linux上是絕對路徑,若無法確認可以用第三方ftp用戶端核實一下

7.ftp勾選匿名登入時，帳號需要寫為anonymous，密碼為空

8.華為obs若無法連結可以用華為obs用戶端測試一下，是否能夠連結，

   華為obs用戶端下載位址: https://support.huaweicloud.com/browsertg-obs/obs_03_1003.html

9.DELIGHT_IMAGE函式的<預設>圖片佈局和TOIMAGE函式的<預設>圖片佈局在調整儲存格大小時有時會顯示不一致，原因如下

 1).TOIMAG是在<預設>圖片佈局設定下，生成生成儲存格內容時，獲取圖片大小和儲存格大小動態調整了圖片在儲存格內顯示的佈局,在報表生成結果內容比較耗費時間

 2).DELIGHT_IMAGE是在報表生成結果內容後，再動態獲取圖片內容的，無法實現TOIMAG在<預設>圖片佈局時，動態調整圖片佈局功能,，但在報表生成結果內容時耗費時間比較短