Skip to content

H
hel-developer-guide
Commit 3976280f authored by 高洋's avatar 高洋
Browse files
Options

Track 14 files into repository. 

- untracked assets/excelImport.png
- untracked assets/redis-dir.jpg
- untracked assets/redis-sentinel.jpg
- untracked assets/redis01.png
- untracked assets/redis02.png
- removed docx4j.md
- removed jad.md
- modified 前端组件/hlsCombobox.md
- removed 前端组件/hlsDataSource
- modified 前端组件/hlsDatePicker.md
- modified 前端组件/hlsMaskedTextBox.md
- untracked 框架功能描述/docx4j.md
- untracked 框架功能描述/jad.md
- modified 融租易开发手册.md

Auto commit by GitBook Editor
parent 32c74bd1
Show whitespace changes
Inline Side-by-side
Showing with 161 additions and 145 deletions
jad.md deleted 100644 → 0
View file @ 32c74bd1
## Excel文件批量导出
本系统支持Excel文件导出排队处理，支持超大数据量，能实时查询文件生成情况，支持取消导出。
#### 使用方法
1. 在代码中注入Excel导出Service
```java
@AutoWired
private ExcelExportServiceImpl excelService;
```
2. 在自己的controller中调用方法
```java
excelService.saveExportInfo(sqlId,iRequest,config,rowMaxNumber);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| sqlId | String | mybatis对应的数据库查询语句的ID |
| iRequest | IRequest | 带有上下文信息的reuqest对象 |
| config | ExportConfig | 包含Excel各列信息的对象，由前台传递json对象转换而来 |
| rowMaxNumber | int | 生成Excel的最大行数，可使用重载方法，不包含次参数默认为1,000,000 |
3. 运行Excel导出程序(获取该程序，请联系部门相关负责人)
```shell
java -jar hel-batch-parent.jar &
```
4. Excel导出情况查询
用户若是为管理员身份，则查询全部人的导出情况，否则只显示当前用户的导出数据
```java
excelService.queryExportInfo(status, iRequest);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| status | String | 指定Excel导出的状态，该参数可为空查询全部状态数据<br><ll><li>new->等待</li><li>generating->文件导出中</li><li>finished->导出完成</li><li>failed-> 导出失败</li></ll> |
| iRequest | IRequest | 带有上下文信息的reuqest对象 |
5. 下载已完成的Excel文件
```java
excel.downloadExcel(filePath, fileName, request, response);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| filePath | String | 需要下载的文件的路径 |
| fileName | String | 想要保存的文件的名称 |
| request | HttpServletRequest | 用户的请求对象 |
| response | HttpServletResponse | 用户的响应对象 |
**下载前，需要检查config.properties文件中的export.offerUrl配置项是否配置正确，且为hel-batch-parent.jar提供的文件下载url**
\ No newline at end of file
前端组件/hlsCombobox.md
View file @ 3976280f
# hlsCombobox标签
# hlsCombobox标签（下拉框）
ComboBox下拉列表组件，通常数据源以code - meaning形式出现，用户操作的是meaning，实际保存的是code。
......@@ -20,52 +20,24 @@ ComboBox下拉列表组件，通常数据源以code - meaning形式出现，用
```
### **主要属性**
属性名 | 类型
-------- | ---
id | String
promptColspan | String
promptClassName | String
promptImage | String
prompt | String
colspan | String
hlsClassName | String
animation | Boolean
autoBind | Boolean
autoWidth | Boolean
cascadeFrom| String
cascadeFromField | String
clearButton| Boolean
dataSource | DataSource
dataTextField | String
dataValueField| String
delay | Number
enable | Boolean
enforceMinLength| Boolean
filter | String
fixedGroupTemplate| String \| Function
footerTemplate| String \| Function
groupTemplate| String \| Function
height| Number
highlightFirst| Boolean
ignoreCase| Boolean
index| Number
minLength| Number
noDataTemplate| String \| Function
placeholder | String
suggest| Boolean
headerTemplate| String \| Function
template| String \| Function
text| String
value| String
valuePrimitive| Boolean
virtual| Boolean
change| Function
close| Function
dataBound | Function
filtering| Function
open| Function
select| Function
cascade| Function
属性名 | 类型 | 说明 |
--- | --- | --- |
id | String | id |
promptColspan | String | 提示语句需要占几列 |
promptClassName | String | 提示语句类名，默认不填 |
promptImage | String | 提示前面的文字图形，默认不填 |
prompt | String | 提示信息 |
colspan | String | 所占列数 |
hlsClassName | String | 类名，默认不填 |
dataSource | DataSource | 数据源 |
dataTextField | String | 返回的显示描述字段 |
dataValueField| String | 绑定的英文字段 |
enable | Boolean | 是否可编辑，true为可编辑，false不可编辑 |
placeholder | String | 占位符 |
template| Function| 渲染函数 |
change| Function | 数据变化时触发的函数 |
> 属性用法请参考KendoUI文档 [http://docs.telerik.com/kendo-ui/api/javascript/ui/combobox](http://docs.telerik.com/kendo-ui/api/javascript/ui/combobox)
......
前端组件/hlsDatePicker.md
View file @ 3976280f
......@@ -9,33 +9,24 @@ xml配置
```
### **主要属性**
属性名 | 类型
-------- | -----
promptColspan | Integer
promptClassName | String
promptImage | String
prompt | String
colspan | Integer
hlsClassName | String
animation | Boolean
ARIATemplate| String
culture | String
depth| String
footer| String & Function
format| String
max| String
min| String
start| String
value | String
name | String
bind | Function
required | Boolean
change | Function
close| Function
open | Function
placeholder | String
interval |Integer
timeFormat |String
属性名 | 类型 | 说明 |
-------- | -----| --- |
promptColspan | Integer | 描述字段所占列数 |
promptClassName | String| 描述的样式名称 |
prompt | String| 描述 |
colspan | Integer | datePicker所占列数 |
hlsClassName | String | 样式名称 |
animation | Boolean | 动画 |
format| String | 格式化 |
max| String | 最大时间 |
min| String | 最小时间 |
value | String | 值 |
name | String | name属性 |
bind | Function | 绑定数据 |
required | Boolean | 必输 |
change | Function | chang事件 |
placeholder | String | 占位符 |
timeFormat |String| 时间格式化 |
> **提示:** 属性用法请参考kendoui API文档 http://docs.telerik.com/kendo-ui/api/javascript/ui/datetimepicker
......
前端组件/hlsMaskedTextBox.md
View file @ 3976280f
## hlsMaskedTextBox
## hlsMaskedTextBox（文本框）
格式框
......@@ -15,20 +15,17 @@
>
> * 属性用法请参考kendoui API文档的maskedTextBox:[http:\/\/docs.telerik.com\/kendo-ui\/api\/javascript\/ui\/maskedtextbox](http://docs.telerik.com/kendo-ui/api/javascript/ui/maskedtextbox)
| 属性名 | 类型 |
| --- | --- |
| clearPromptChar | Boolean |
| culture | String |
| mask | String |
| promptChar | String |
| unmaskOnPost | Boolean |
| value | String |
| change | Function |
| caseLetter | String |
| clearButton | Boolean |
| placeholder | String |
| bind | Function |
| required | Boolean |
| 属性名 | 类型 | 说明 |
| --- | --- | --- |
| id | String | 唯一英文标识 |
| promptColspan | number | 该数字将会与col-sm-？进行拼接，替代问号，生成对应bootstrap的css样式，渲染描述的样式 |
| promptClassName | String | 描述的样式名称，会将对应的样式添加到描述中 |
| promptImage | String | 描述前面的一个文本图像，在设置为必填的时候会出现一个红色的* |
| prompt | String | 中文描述 || colspan| number | 该数字会与col-sm-?进行拼接，替代问号，生成对应bootStrap的css样式，渲染文本框的样式 |
| hlsClassName | String | 标签的样式名称 |
| placeholder | String | 占位符 |
| bind | expressions | 绑定数据 |
用法示例：
......@@ -53,8 +50,9 @@ function rules(){
```
```xml
<h:hlsMaskedTextBox id="hlsMaskedtTextBox">
<h:rules "~"="/[+-]/" "^"="fn:rules"/>
<h:hlsMaskedTextBox id="hlsMaskedtTextBox" placeholder="hlsMaskedTextBox" prompt="hlsMaskedTextBox"
bind="model" bind="enabled: isEnabled, value:data.textBox">
</h:hlsMaskedTextBox>
```
......
框架功能描述/jad.md 0 → 100644
View file @ 3976280f
## Excel文件导入
使用poi解析xml方式进行导入，只支持单表导入。
数据库批量导入默认batch为100.
支持多sheet导入，sheet1从第三行开始读取数据，其他sheet页从第一行导入数据。
使用方法：
1. Excel文件上传
```javascript
$("#files").kendoUpload({
async: {
saveUrl: "${base.contextPath}/hls/excel/import?${_csrf.parameterName}=${_csrf.token}&templateCode=HLS_FIN_STATEMENT_LN",
removeUrl: "remove"
},
showFileList: false,
upload: onUpload,
success: onSuccess
});
```
| 参数名 | 描述 |
| :--: | :--: |
| _csrf.token | 防跨域token |
| templateCode | 作为模块标识，会出现先在fnd_interface_header中，供后续业务逻辑进行处理 |
2. 处理数据
经过第一步的文件上传，后台会在fnd_interface_header表中生成一条数据，其中包含了传递的templateCode参数作为code，并且，在fnd_interface_lines表中按照顺序，将Excel文件中的每一行数据保存为一条数据，数据的第一列保存在attributes_1上，依次类推。
![ExcelImport](/assets/excelImport.png)
## Excel文件批量导出
本系统支持Excel文件导出排队处理，支持超大数据量，能实时查询文件生成情况，支持取消导出。
#### 前端使用方法
调用js方法
```javascript
Hel.exportExcel=function(opts){
var contextPath =opts.contextPath,
id=opts.id,
view_model=opts.viewModel,
viewModelData=opts.viewModelData,
controller_name = opts.controller,
fileName = opts.fileName,
temp_div_id=opts.tempDivId,
dataSourceId = opts.dataSourceId,
_csrf_token = opts._csrf_token;
```
| 参数名 | 描述 |
| :--: | :--: |
| contextPath | 项目的url路径 |
| id | 页面上grid的id |
| view_model | grid绑定的model数据模型 |
| viewModelData | model模型中的数据 |
| controller_name | 后端控制器名称 |
| fileName | excel文件名 |
| temp_div_id | 临时div的id |
| dataSourceId | 数据源id |
| _csrf_token | 防跨域的token |
#### 后端使用方法
1. 在代码中注入Excel导出Service
```java
@AutoWired
private ExcelExportServiceImpl excelService;
```
2. 在自己的controller中调用方法
```java
excelService.saveExportInfo(sqlId,iRequest,config,rowMaxNumber);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| sqlId | String | mybatis对应的数据库查询语句的ID |
| iRequest | IRequest | 带有上下文信息的reuqest对象 |
| config | ExportConfig | 包含Excel各列信息的对象，由前台传递json对象转换而来 |
| rowMaxNumber | int | 生成Excel的最大行数，可使用重载方法，不包含次参数默认为1,000,000 |
3. 运行Excel导出程序(获取该程序，请联系部门相关负责人)
```shell
java -jar hel-batch-parent.jar &
```
4. Excel导出情况查询
用户若是为管理员身份，则查询全部人的导出情况，否则只显示当前用户的导出数据
```java
excelService.queryExportInfo(status, iRequest);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| status | String | 指定Excel导出的状态，该参数可为空查询全部状态数据<br><ul><li>new->等待</li><li>generating->文件导出中</li><li>finished->导出完成</li><li>failed-> 导出失败</li></ul> |
| iRequest | IRequest | 带有上下文信息的reuqest对象 |
5. 下载已完成的Excel文件
```java
excel.downloadExcel(filePath, fileName, request, response);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| filePath | String | 需要下载的文件的路径 |
| fileName | String | 想要保存的文件的名称 |
| request | HttpServletRequest | 用户的请求对象 |
| response | HttpServletResponse | 用户的响应对象 |
**下载前，需要检查config.properties文件中的export.offerUrl配置项是否配置正确，且为hel-batch-parent.jar提供的文件下载url**
\ No newline at end of file
融租易开发手册.md
View file @ 3976280f
......@@ -60,7 +60,8 @@
* [6.1 计划任务](/框架功能描述/计划任务.md)
* [6.2 RabbitMq消息队列](/后端开发/RabbitMq消息队列.md)
* [6.3 应用服务部署(tomcat/weblogic)](/框架功能描述/deployment.md)
* [6.4 合同文本生成](/docx4j.md)
* [6.4 合同文本生成](/框架功能描述/docx4j.md)
* [6.5 Excel导入导出](/框架功能描述/jad.md)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment