易发联中间数据库二次开发接口说明

1、易发联中间数据库二次开发接口说明易发联传真服务器真正支持Windows“服务”的方式，可以在任意电脑上共享或多人同时远程管理。易发联传真服务器采用高端的传真板卡（易发联33.6Kbps高速传真卡、进口卡DIALOG或者国产卡三汇传真卡），配置灵活，可自备服务器，支持OEM定制开发等。一、支持的数据库DBMS目前支持的数据库包括MS SQLSERVER2000（sp4以上），MS SQL2005及以上版本；MYSQL 5.0版本；ORACLE 8.0以上。易发联服务器软件访问数据库的方式为ODBC数据源（DSN）的方式。因此，对于上述几种数据库，在传真服务器上必须正确安装相关的ODBC驱动程序。

2、传真服务器的数据库名称，可以用户自定义，比如可以定义为elm_database。传真发送表的名称固定为：elm_sendtask；传真接收表的名称固定为：elm_receivetask。已经定义好的表结构字段名称不能随意改动，OA软件处理时，如果字段不够使用，可以自行任意扩展，但每个扩展字段必须有默认值。二、DBA二次开发数据库表结构定义发送传真任务表表名：elm_sendtask字段名类型长度（字节）说明taskidINTEGER4任务ID，主键，自增长dbaverINTEGER4DBA二次开发数据库接口版本，default=0SubjectVARCHAR200传真主题faxphoneVAR

3、CHAR70传真号码（如87654321；01081234567）usernameVARCHAR100提交任务的用户名（对应传真管理器中的用户姓名或者公共文件夹名称（必须支持发件箱），如果填写的名称在传真服务器上存在的话，则发送记录同时保存到该用户或公共文件夹发件箱中，如果不存在，则发送记录保存到服务器上默认的系统公共文件夹（默认对所有设备有效）。SenderVARCHAR100发件人，标识传真发件人，如公司名ReceiverVARCHAR100收件人，标识传真收件人，如公司名submodeINTEGER4提交文件方式。Default=00=绝对路径；1=局域网络共享文件路径2=URL方式指定

4、路径3=文件正文保存在数据库sendfile字段中4=仅文件名，文件路径在在数据库接口配置页面中配置Other=暂不支持filenameVARCHAR500待发送文件。Filename指定的文件方式依赖字段submode的值。1、 submode=0时filename表示文件的绝对路径，多个文件之间用“|”相隔（例如： “D:EasyfaxServerInterFile传真.doc”）。2、submode=1时filename表示局域网共享文件路径，多个文件之间用“|”相隔（例如：docfax.doc）3、submode=2时此时filename标识的是以URL HTTP

5、形式表示的文件地址（此时只能填写一个文件）。（例如：HTTP:/WWW.TEST.COM/FAX/TESTFILE.DOC）4、submode=3时此时，filename标识文件名，如“传真.doc”（该字段只能填写一个文件名）；同时sendfile字段为当前文件的正文。5、submode=4时Filename标识文件名，多个文件之间用“|”相隔（例如： “传真.doc”）。SendfileMYSQL：LONGBLOBMSSQL2005以后：varbinary(max)MSSQL2000：IMAGEORACLE：BLOBsubmode=3时，该字段是要发送的文档二进制正文对象default=N

6、ULLTransFileNameVARCHAR260转换后传真文件名（TIF或PDF格式，绝对路径），发送完成后由系统回写LevelINTEGER4发送标志（必填，default=0）：数值越大，优先级越高0：低优先级；1：普通优先级；2：高优先级LineINTEGER4选择线路（必填）：default=00：自动调度；1：选择第一条线路；2：选择第二条线路其他为选择线路发送，暂不支持StatusINTEGER4任务状态：default=00：提交（等待转换）1：等待发送（传真服务器已从数据库读取该记录）2：完成（任务处理完成，结果根据retcode判断）添加新任务时固定填写为0，发送结束后状

7、态由系统回写RetcodeINTEGER4结果码，发送完成后由系统回写0=成功1=未知原因2=忙3=无拨号音4=无应答5=传真文件格式错6=发送传真页前协商阶段B断开连接7=线路训练失败8=传真发送阶段失败9=传真发送页后协商阶段D断开连接10=用户取消11=超时12=线路错误异常13=拨号号码格式错误14=传真收发阶段错误(U口)15=传真意外中断(U口)16=创建文件失败17=设备无回应(U口)18=本地电话线路占用19=本地未连接电话线路20=待发送文件错误21=系统读写错误22=权限错误（无发送权限等）23=打印转换时出错24=没有附件或附件不存在25=收件人信息格式错误或不完整26=

8、文档不支持自动转换27=接收方不是传真设备28=接收方拒绝接收（URL HTTP方式）100=连接服务器失败101=文件下载失败subtimeINTEGER4任务提交时间（用户自己填写）（标准C time_t格式，从1970年1月1日0时0分0秒开始计算的秒数）该字段已经不再使用，默认填0即可。scheduletimeINTEGER4计划发送时间（用户自己填写）（标准C time_t格式，从1970年1月1日0时0分0秒开始计算的秒数）, 默认填0即可。（功能上等同于字符串类型的自动extstr1）txtimeINTEGER4发送时间（标准C time_t格式，从1970年1月1日0时0分0秒

9、开始计算的秒数），发送完成后由系统回写功能上等同数字类型的字段extstr2tasksubtypeINTEGER4提交类型 default=00：DBA接口提交1：其他方式提交（客户端或email）该字段仅供OA软件判断传真提交的方式readflagINTEGER4已读标识0：未读；1：已读serveridINTEGER4服务器ID Default=0在多台服务器同时处理接口中的任务时，标识传真发送时实际从那一台服务器出去的。服务器ID在传真服务器上配置（传真服务器安装时，默认的服务器ID为1，多台服务器处理时，建议把不同传真服务器的ID值配置为不同值）。在添加新发送记录时，serverid必

10、须=0；非0值由传真系统回写linenameVARCHAR100实际发送传真的线路名称或标识（在传真服务器上配置线路设备名称），由传真系统回写Extint1INTEGER4扩展字段1，默认为0Extint2INTEGER4扩展字段2，默认为0Extstr1VARCHAR260Default=null扩展字符串字段1，字符串类型的计划发送时间，如：2014/6/16 17:20:20（年/月/日 时:分:秒）功能上等同于数字类型的字段scheduletime。如果使用Extstr1作为计划发送的时间，则scheduletime填写为0；如果scheduletime为非0则自动忽略extstr1字

11、段。Exitstr2VARCHAR260扩展字符串字段2，字符串类型的发送时间，如：2014/6/16 17:20:20（年/月/日 时:分:秒）由系统自动填写，功能上等同数字类型的txtime。红色字体标识的为OA接口必填项目或注意地方，蓝色为建议填写项目。接收传真任务表表名：elm_receivetask字段名类型长度（字节）说明TaskidINTEGER4任务ID，主键，自增长dbaverINTEGER4DBA二次开发数据库接口版本，default=0subjectVARCHAR200传真主题usernameVARCHAR100传真接收的用户，对应服务器上的用户名称faxphoneVAR

12、CHAR70传真号码（发送方传真号码或来电显示，如83235170）SenderVARCHAR100发件人1，标识传真发件人，如公司名receiverVARCHAR100收件人1，标识传真收件人，如公司名、部门等extensionVARCHAR20分机号码FilenameVARCHAR260传真文件名（TIF或PDF格式）。具体格式参考submode字段receivefileMYSQL：LONGBLOBMSSQL2005以后：varbinary(max)MSSQL2000：IMAGEORACLE：BLOB服务器端设定了保存传真文件到数据库功能时，该字段保存传真文件的正文BLOB类型Defaul

13、t:NULLsubmodeINTEGER4传真文件写入数据库的方式：default=00=仅文件名（Filename为文件的绝对路径）1=文件名+文件正文（Filename为文件的绝对路径；receivefile为接收文件的正文，二进制BLOB存储）2=仅文件名，路径在数据库接口配置选项中配置PageINTEGER4传真页数rxtimeINTEGER4接收时间（标准C time_t格式，从1970年1月1日0时0分0秒开始计算的秒数）功能上等同字符串类型的字段extstr1。linenameVARCHAR100主要用在多路的情况下标识传真是从哪条线路过来readflagINTEGER4已读标识

14、0：未读；1：已读serveridINTEGER4服务器ID，在多台服务器接收传真回写数据库，标识当前传真是哪台服务器接收的。服务器ID可以在服务器上指定Extint1INTEGER4扩展字段1，默认为0Extint2INTEGER4扩展字段2，默认为0Extstr1VARCHAR260扩展字符串字段1，字符串类型的接收时间，如：2014/6/16 17:20:20（年/月/日 时:分:秒）由系统自动填写，功能上等同数字类型的rxtime。Exitstr2VARCHAR260扩展字符串字段2，默认为空三、数据库接口配置说明1、配置数据源在WINDOWS控制面板à管理工具中打开“数据源

15、（ODBC）”，如图所示，在系统DSN（因为传真服务器采用标准windows服务访问方式，因此添加数据源必须是系统DSN）中点击“添加”按钮，在桌面弹出窗口中选择对应的数据库驱动程序，根据系统提示，完成数据源的创建。2、易发联传真服务器DBA接口配置在传真服务器登录完成窗口中打开“程序选项”窗口，并选择“数据库接口选项”，如图所示。在配置窗口中，正确填写创建的数据源名称，数据库用户账户名称和密码。勾选“启用数据库接口收发传真功能”选项。默认情况下，传真服务器每隔60秒从数据源中读一次传真记录；用户可以根据需要自行设定（不建议设置时间太短，否则会增加数据库的访问，降低系统效率）。传真系统支持保留

16、或自动删除通过接口提交的文档附件原稿，用户根据需要配置即可。如果需要把从传真客户端提交发送的传真记录回写到数据库时，勾选“非数据库接口提交的传真发送结束后，记录回写到数据库”选项即可。默认条件下，接收的传真记录，在写数据库时，仅写入文件名，如果需要的话，可以勾选“保存接收传真正文内容到数据库”选项（建议用户从数据库读取后，从数据库删除正文内容，否则会明显降低数据库访问效率）。3、支持的附件格式数据库接口中提交的文档格式可以是以下格式，如doc，xls，txt，wri，tif，jpg，pdf 等。同时要求在传真服务器端正确安装了以上格式的软件，并支持自动转换功能，提交的文档中确定没有密

17、码等安全设定。4、传真服务器端要求与配置传真服务器安装时自动向系统中注册了EasyLanfax服务模块，必须将EasyLanfax服务和本机Windows账户关联起来，即让EasyLanfax做为本机账户的服务运行。安装完传真服务器后，做如下修改：打开Windows控制面板，找到“管理工具”，在“管理工具”中找到“服务”图标双击运行，如下图所示，在“服务”管理窗口中搜索“EasyLanfax”服务，找到后双击打开，先停止运行服务，然后选择“登录”属性页，如图所示。按图中选择登录身份，输入本机Windows账户名称、密码（建议最好输入具有管理员权限的账户）。点击确定，然后重新运行服务即可。Windows服务管理窗口EasyLanfax服务属性窗口四、数据库接口使用说明或注意事项1、关于MYS