接口程序配置说明v10.docx
《接口程序配置说明v10.docx》由会员分享,可在线阅读,更多相关《接口程序配置说明v10.docx(14页珍藏版)》请在冰豆网上搜索。
![接口程序配置说明v10.docx](https://file1.bdocx.com/fileroot1/2023-5/25/c30ca7fe-22a3-423e-814a-8988df126abe/c30ca7fe-22a3-423e-814a-8988df126abe1.gif)
接口程序配置说明v10
北京东方飞扬软件技术有限责任公司
文档编号
产品版本
密级
ES-DN-2008-09-24-01
V1.0
产品名称:
ES-Interface通用接口程序
共页
接口配置说明
(仅供内部使用)
文档作者:
日期:
开发/测试经理:
日期:
产品经理:
日期:
产品总监:
日期:
北京东方飞扬软件技术有限责任公司
版权所有不得复制
目录
第一部分客户端接口程序2
一、运行环境要求2
二、运行前的准备工作3
三、接口参数配置及数据转换3
第二部分服务器端接口程序10
一、运行环境要求10
二、运行前的准备工作10
三、操作界面及操作说明11
第四部分:
常见问题和注意事项12
一、常见问题12
二、注意事项13
第一部分客户端接口程序
一、运行环境要求
1、Window98/2000/XP/2003,系统硬盘1G空间以上;
2、在运行接口程序的计算机上安装LotusNotes6.0.i系列客户端软件,并提供拥有足够权限(能读写所有数据)的用户的标识符文件(一般为admin.id或user.id),通过此文件,保证lotus客户端能访问OA服务器;
3、注册lotus的安装目录(假设安装目录为C:
\lotus)下的动态库文件nlsxbe.dll,点击“开始”——“运行”,输入regsvr32C:
\lotus\notes\nlsxbe.dll;若lotus的安装目录的路径中有空格,如:
C:
\ProgramFiles\lotus,则点击“开始”——“运行”,输入regsvr32“C:
\lotus\notes\nlsxbe.dll”
4、若是ORACLE数据库,则要在运行接口程序的计算机上安装ORACLE客户端软件,并保证客户端能访问档案数据库;
二、运行前的准备工作
1、注册lotus的安装目录(假设安装目录为C:
\lotus)下的动态库文件nlsxbe.dll,点击“开始”——“运行”,输入regsvr32C:
\lotus\notes\nlsxbe.dll;若lotus的安装目录的路径中有空格,如:
C:
\ProgramFiles\lotus,则点击“开始”——“运行”,输入regsvr32“C:
\lotus\notes\nlsxbe.dll”;
3、对转换OA接口程序的机器系统时间格式进行设置;步骤为:
点击“开始”——>“控制面板”——>“区域和语言选项”——>“自定义”——>“日期”——>“短日期格式”,将yyyy-M-d改为yyyy-MM-dd。
未设置“短日期格式”,转换过来的日期为在文件库中显示为2006-1-1,设置完成的,转换过来的日期为2006-01-01;此步骤解决收、发文日期补零问题。
三、接口参数配置及数据转换
1、在安装飞扬OA接口客户端组件后,依次点击“开始”、“程序”、“飞扬OA接口客户端组件”、“参数设置”,(或者直接运行接口目录下的set_client.exe)进行各项参数的设置,保证飞扬OA接口客户端组件能按照设定的参数访问档案数据库,如图:
服务名称:
档案数据库对应的ORACLE服务名。
2、配置USER.INI中其他参数项:
esamsver=//档案系统版本,本接口支持v52,v53,v61
regunit=//注册单位名称
oadbtype=lotus//目前版本只支持lotus
2、在安装飞扬OA接口客户端组件后,在桌面会创建接口程序的快捷方式,可双击快捷方式,也可依次点击“开始”、“程序”、“飞扬OA接口客户端组件”、“Es-InterFaceV1.0”(或运行接口目录下的Es-InterFace.exe)可进入系统。
系统登录用户和口令与档案系统的一致,输入口令后,单击”登录”按钮即可,如图:
3、在档案软件的定义文件模版或定义档案模版中定制符合用户需求的文件库结构,收文、发文及签报中都需要增加这个字段,并且要增加各年度的收文、发文及签报库的数据节点;如:
在收文库中增加2006年收文,在发文库中增加2006年发文;
4、接口的主界面,如下图:
5、点击“增加”/“修改”工具按钮,可以设置连接OA服务器的参数、电子文件存放方式和档案库及FTP服务器的参数设置。
界面如下图所示:
基本参数配置包括(接口名称、接口类型、档案类型、档案库名称、FTP路径、OA服务器IP、OA密码、OA库名称、OA表/视图、标题域名称、转换条件)
接口名称:
区分每个接口的功能,如:
2008年度收文;
接口类型:
接口的种类,可以通过“类型维护”功能对接口类型进行维护,如:
收文、发文等;
档案类型/档案库名称:
双击“选择”按钮,会弹出一个类似于档案管理系统中文件登记的一个目录树,其中可以,点击发文库,双击“2006年发文”,此预归档库即可自动写入“档案库表、档案类型”的信息。
FTP路径:
配置电子文件在档案ftp的存放位置,要求ftp上必须存在所需要的路径。
如:
/data/sw/2008/
OA服务器IP:
OA数据库的地址,如10.192.100.130
OA密码:
即运行环境要求中LOTUS客户端用户对应的口令,如:
password;
OA库名称:
要归档的数据所在的库名称
OA表/视图:
在LOTUS客户端中显示数据的视图名称,如:
vwAllArchives;
标题域名称:
文件标题在OA域中的名称,如:
(Subject);
转换条件:
设置数据接收的条件语法field域名称关系符值,关系符包括:
>、<、=、contains,如:
fieldMarkYear=2008andfieldsubjectcontains标题
以上参数配置完毕,点击保存按钮即可。
扩展参数设置界面如下图:
电子文件接收设置:
分为两种方式
1、电子文件在主数据库中
2、中美集团,001
3、[中美集团]第001期
4、“[”+$F{bt}+”第”+$F{id}+”期”
函数配置如下:
$Yw_Lotus{类型、文件命名规则},类型包括InSelf、InOtherDb
例如:
$Yw_Lotus{“InSelf”,”SW_”+$F{UNID}}
其中,文件命名规则中可以有字符串和OA域名连接构成。
如“SW_”+$F{UNID},注意两个特定域$F{NOTEID}代表档案条目在OA中的唯一标识,$F{UNIVERSALID}代表OA条目的序列值。
命名规则项为“”
空时,代表取OA中的文件名称。
5、电子文件在其他数据库中
函数配置如下:
$F{类型,电子文件库名,视图名,电子文件关联条件}
例如:
$Yw_Lotus{"InOtherDB","",$F{MSSDatabase},"AllAttachmentView","fieldDOCUNID="+$F{UNID}}
设置完毕保存即可。
6、追加携带功能,在增加新的接口类型时,可以对打对勾携带列的接口类型的相关配置进行复制,产生一条新的接口类型记录。
7、增加接口类别后,需点击每条接口记录后的“设置”按钮,对OA数据库域和对应的档案库表的字段之间的对应关系进行设置;设置完成后,点击“保存”按钮,如下图所示:
Oa域定义规则:
1、””之间的代表固定值。
2、$F{}代表OA域方式。
组合效果如下:
①加前后缀方式:
”0001”+$F{Oa域}或$F{OA域}+”0001”
②多域组合方式:
$F{Oa域1}+$F{Oa域2}+$F{Oa域3}
删除/替换功能:
针对OA域的值进行相关操作。
为了方便选择OA域,可以配置Oafield.ini中的相关域列表配置。
8、设置完成后,在接口主界面的右侧单击“显示数据”按钮,就会显示出指定的OA数据;
9、显示数据后,点“执行转换”,即可转换数据。
10、转换的日志查看。
点击“查看日志”按钮,会弹出查看日志窗口,如图:
11、点击左边窗口的某行的日志文件名(文件名由“log”加上执行转换的年月日时分秒构成),会显示本次转换的信息,包括转换类别、错误的sql语句和转换数据的应转换和实转换数据的记录数。
也可以删除当前日志。
12、转换出错的处理。
将日志中转换出错的语句复制下来,点击“sql执行”按钮,会弹出一个sql语句执行工具窗口,将日志中转换出错的语句拷贝到此窗口中,点击“执行”按钮,如下图所示:
第二部分服务器端接口程序
一、运行环境要求
1、Windows2000server/Windowsserver2003,系统硬盘40G空间以上;
2、在运行接口程序的计算机上安装LotusNotes6.0.i系列客户端软件,并提供拥有足够权限(能读写所有数据)的用户的标识符文件(一般为admin.id或user.id),通过此文件,保证lotus客户端能访问OA服务器;
3、ftp服务器也设置在档案服务器上。
二、运行前的准备工作
必须按照客户端程序的说明设置完成并能正常转换的前提下,才能运行服务器端程序。
在安装飞扬OA接口程序(服务器端)后,依次点击“开始”、“程序”、“飞扬OA接口服务器组件”、“参数设置”,进行各项参数的设置,保证OA接口服务器组件能按照设定的参数访问档案数据库,如图
1、数据库类型:
可以选择sqlserver或oracle,根据具体单位来设置。
2、服务名称:
档案数据库对应的ORACLE服务名称;
3、必须已经通过飞扬OA接口客户端组件建立了各种接口类别的参数。
在填写了服务名称后,单击”测试”按钮,可以测试是否能正确连接到档案数据库;
三、操作界面及操作说明
在安装飞扬OA接口服务器组件后,依次点击“开始”、“程序”、“飞扬OA接口服务器组件”、“OA接口服务”即可进入系统。
OA接口服务器组件主界面如下图:
1、功能包括:
接收频率、手工转换、开始/继续、暂停、停止和查看日志等功能,具体功能如下:
A、接收频率,用户可以设置服务器端接口程序每天/每周/每月转换数据的时间
B、开始/继续,启动接口程序,接口程序会在设置的时间自动进行数据的转换;
C、暂停/停止,终止已经运行的接口程序,即使在设置的时间也不会转换数据;
D、手工转换,手工启动转换数据,转换后不再转换;
E、
按钮,点击后可以选择转换配置转换哪些接口类型的数据。
F、查看日志,查看历史的接收的日志记录。
2、启动OS时自动启动服务:
当启动操作系统时,自动运行服务器端接口程序,并自动开始服务。
第四部分:
常见问题和注意事项
一、常见问题
1、不能登录OA接口客户端程序
原因:
OA接口客户端程序配置参数不正确或网络不通
2、不能显示OA数据
原因:
A、lotus的安装目录下的nlsxbe.dll没有注册;
B、接口类别中的参数配置不正确,如:
视图名称不对;
C、OA中的数据没有指定范围条件下的数据。
3、不能转换数据
原因:
A、若转换日志中未记录的,原因为数据附件有问题,若转换日志中记录的,按照日志中的提示失败的语句找出失败原因,手工重新执行一次;
B、文件库中的字段长度小于OA中字段长度。
4、不能连接FTP服务器
原因:
A、网络不通;
B、档案系统中的FTP用户名或口令不正确
5、转换到文件库中的日期为2006-1-1
原因:
将“控制面板”——>“区域和语言选项”——>“自定义”——>“日期”——>“短日期格式”,yyyy-M-d改为yyyy-MM-dd。
6、不能自动转换数据
原因:
A、OA服务没有启动;
B、不能连接OA服务器;
C、某条数据字段或附件有问题,查看转换日志;
二、注意事项
1、在安装完成lotus客户端程序后,必须要注册nlsxbe.dll动态库文件
2、要将“控制面板”——>“区域和语言选项”——>“自定义”——>“日期”——>“短日期格式”,yyyy-M-d改为yyyy-MM-dd。
3、在配置接口类别及配置字段对应关系的过程中,要确保参数是正确的,如:
OA服务器名称,OA口令,视图名称等;