# EasyScan web-API使用说明
## 1. 页面功能模块说明
* Lis-module-easyscan-common-web：  
      影像页面模块，对其他涉及影像功能页面模块提供影像页面查询服务，用于其他模块页面功能的jsp调用入口处理，负责查询相关影像信息并展示和反馈给其他页面模块。
* lis-module-easyscan-common-service：  
      服务于Lis-module-easyscan-common-web，用于web功能的后台查询处理。
## 2. Web-API使用说明
### 2.1 模块依赖：
``` pom
<dependency>
    <groupId>com.sinosoft.lis.module.easyscan</groupId>
    <artifactId>lis-module-easyscan-common-web</artifactId>
    <type>war</type>
</dependency>
```
> 其他模块只允许依赖lis-module-easyscan-common-web,   
> 不允许依赖lis-module-easyscan-common-service（在LIS-WEB中增加依赖）

### 2.2 目前的主要功能有：
* 1.纯影像展示
* 2.影像随动
* 3.签名影像的查询与定制

### 2.3 页面jsp调用使用说明
* 2.3.1 纯影像展示
  > 通过引用`webapp/image/ImageQueryMain.jsp`, 并将必要参数传入即可，具体参数如下：
  - 1.&nbsp;showImageGrid: 
      - 0-仅显示影像
        ![影像展示0](./showImageGrid0.jpg)
      - 显示影像结果集列表Grid的方式
    ![影像展示1](./showImageGrid1.jpg)
  - 2.&nbsp;clientUrl：请求模块页面客户端的请求地址，非必传。
  - 3.&nbsp;BizNo：业务号码（必传）
    > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;查询各个业务下的影像资料业务号码，在影像模块用于存储在影像关联表es_doc_relation的bussno，
    该业务号可以是投保单号、保全申请书号等，根据具体的业务类型来存储和进行查询。
  - 4.&nbsp;BizNoType：业务号码类型
    > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;在影像模块用于存储在影像关联表es_doc_relation的bussnotype，其他模块调用影像模块进行查询的码表对应如下：11-个险投保单号、12-团体投保单号、15-通知书印刷流水号、16-电子投保确认书号、23-赔案号、31-保全受理号。  
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;例如：当调用影像模块进行查询的参数【业务号码类型BizType】为 TB（个险契约）、【业务号BizNo】为投保单号时，【业务号码类型BizNoType】可以对应多种类型： 11-个险投保单号、15-通知书印刷流水号等。
  - 5.&nbsp;BizType：业务类型
    > 在影像模块用于存储在影像关联表es_doc_relation的BUSSTYPE  
    >* TB: 个险契约  
    >*  BQ: 个险保全  
    >*  LP: 个险理赔  
    >*  G_NB：团险契约  
    >*  G_POS：团险保全  
    >*  G_CM：团险理赔  
  - 6.&nbsp;SubType：业务单证子类型
    > 影像模块对外开放的标准的业务单证子类型，用于影像模块配置文件esrelation.xml转换成影像自己模块存储各类影像的单证类型，如：UA001、UN101、BQ001等。  
    >* 契约：TB10XX
    >* 保全：BQ10XX
    >* 理赔：LP10XX
    >* 财务：OF10XX
    >* 续保：XB10XX
  - 7.&nbsp;BizNo2：关联业务号
    > 当【查询类型QueryType】参数为2时，可以传此关联业务号进行影像查询，该字段一般是查询显示影像结果集列表Grid的方式时用到，当【查询类型QueryType】参数为其他时，不会用到该参数。  
  - 8.&nbsp;BizNoType2：关联业务号类型
    > 对应于BizNo2的关联业务号类型，取值码表同BizNoType。
  - 9.&nbsp;DocID：单证编码
    > 用于查询影像主表ES_DOC_MAIN。调用影像模块查询，当参数【查询类型QueryType】为 0时，【单证编码DocID】必传。
  - 10.&nbsp;QueryType：查询类型（非必传）
      - QueryType = 0 ：  用单证编码查询影像主表ES_DOC_MAIN，其中参数DocID必传，其他参数都是非必传。
        >- 参数：DocID  
         查询逻辑为：根据单证影像编码DocID查询影像信息。
      
      - QueryType = 1：  如果QueryType为空或者未传，则也会默认为1。【业务号BizNo】必传，其他参数都是非必传。
        >- 参数：BizNo，BizNoType，BizType，SubType  
        &nbsp;&nbsp;&nbsp;&nbsp;查询逻辑为：根据【业务号BizNo】查询相应的影像信息。  
        &nbsp;&nbsp;&nbsp;&nbsp;例如承保处理—》个人保单—》新单查询，点击按钮【投保单影像查询】，参数showImageGrid 为1，显示列表影像集,点选列表中的一条单证影像数据，在影像展示区显示该【单证号】和【影像类别】的对应的影像件信息时，【查询类型QueryType】为1。
      
      - QueryType = 2：【业务号BizNo】必传，其他参数都是非必传。
        >- 参数：BizNo，BizNoType，BizType，SubType，BizNo2，BizNoType2  
          &nbsp;&nbsp;&nbsp;&nbsp;查询逻辑为：查询该【业务号BizNo】和【关联业务号BizNo2】对应的所有影像。  
          &nbsp;&nbsp;&nbsp;&nbsp;如【业务号BizNo】为投保单号，【关联业务号BizNo2】可以传：投保单号、投保确认书号、通知函号。
      
      - QueryType = 3：【业务号BizNo】必传，其他参数都是非必传。
        >- 参数：BizNo，BizNoType，BizType，SubType  
          &nbsp;&nbsp;&nbsp;&nbsp;查询逻辑为：根据【业务号BizNo】查询所有的相关联的影像，一般用在综合查询影像。  
          &nbsp;&nbsp;&nbsp;&nbsp;例如契约个人保单综合查询：根据投保单号查询该投保单下所有关联【单证号】和【影像类别】的影像信息（投保单影像、投保确认书影像、通知函影像）。此时showImageGrid参数一般传1，适用于列表查询影像。如下图：  
          ![QueryType3效果图](./queryType3.jpg)
          
      - QueryType = 9：【业务号BizNo】必传，其他参数都是非必传。
        >- 参数：BizNo，BizNoType，BizType，SubType  
          &nbsp;&nbsp;&nbsp;&nbsp;查询逻辑：根据【业务号BizNo】查询所有的相关联的影像。  
          &nbsp;&nbsp;&nbsp;&nbsp;例如：承保处理--个人保单--新单录入根据【业务号BizNo】查询对应的相关影像，【查询类型QueryType】为9、【参数showImageGrid】 为0（仅显示影像的方式）。
    
* 2.3.2 影像随动
  - 1.通过`frame[id="fraPic" name="fraPic"]`引用`../common/EasyScanQuery/EasyScanQuery.jsp`, 并将必要参数传入即可,具体参数同2.3.1，其中参数showImageGrid=0.
  - 2.`Frame[id="fraInterface" name="fraInterface"]`所指向的jsp中需要引用以下js文件, 并添加onkeydown事件触发函数为`document_onkeydown`。
      ``` javascript
      <script src="../common/EasyScanQuery/ShowPicControl.js"></script>
      <script src="../common/javascript/ScanPicView.js"></script>
      <script language="javascript">window.document.onkeydown = document_onkeydown;</script>
      ```
    > ShowPicControl.js: 影像随动位置控制  
       ScanPicView.js：影像随动位置定位
  * 3.效果图(只展示效果)：  
  ![随动定制效果图](./scanDef.jpg)
  
* 2.3.3 签名影像的查询与定制
  - 1.通过`frame[id="fraPic" name="fraPic"]`引用`../common/EasyScanQuery/EasyScanQuery.jsp`, 并将必要参数传入, 具体参数同2.3.1，其中参数showImageGrid=0.
  - 2.`frame[id="fraInterface" name="fraInterface"]`所指向的jsp中需要引用以下
      ``` javascript
      <script src="../common/javascript/Signature.js"></script>
      ```
  - 3.签名查询按钮标签中需添加一下属性：
    - 该标签中必须有属性id
    - onclick = "signatureQuery(this)"
    - cancut="1"：1=当查询不到签名时是否可以截取和更换签名，0=不可截取，更换；当不存在cancut属性或为空时，默认不可截取和更换签名
    - codetype="PrtNo"：当签名查询时，在当前页面中查找`name=PrtNo`的input控件的值，并将该值传入后台，查询此单子号码下的签名影像页；当codetype为空时，系统默认查找当前页面下`name=PrtNo`的input控件；当在页面中无法找到name=PrtNo的input控件时，系统报错，终止查询签名。
      > （注：PrtNo为示例值，可根据实际情况填写）  
    - 例：  
         ``` javascript
              <input id="sqButton" class=cssButton VALUE="签名查询"  TYPE=button onclick="signatureQuery(this);" cancut="1" codetype="PrtNo">
         ```
  - 4.签名查询效果图：  
  ![签名查询效果图](./signature.jpg)