工具查询enableq问卷调查引擎v3developers manual

1、EnableQ 系统参考手册：数据接口规范0. 2适用3概览3关于hash3系统问卷设计员操作数据接口3调用形式4特别说明5hash 码安全与通信程序示例5用户登录接口的特殊性64.样本数据接口规范74.1 基于ses、方式的同域第应用系统认证84.2 基于Active Directory 服务的应用系统认证84.3 采用Web Service 方式的第应用系统认证9应用场景10设定私有问卷用户特征条件接口程序10删除私有问卷用户特征条件接口程序114.3.4 私有问卷提交检验用户接口程序11单点登录返回用户属性数据接口程序12问卷提交完成后续处理逻辑接口程序134.3.7用户属性与用户属性值

2、14其他特定程序调用15显示全部执行中的程序l.155.2 显示多行填空题内容程序t. 160.EnableQ是能动的商标，并且将在中民或其它司法管辖范围（包括国际管辖范围）内。本物中提及的其它产品名称、徽标、设计、标或其它实体的商标、服务标志或商标名称，题、单词或短语是能动并且将在某些司法管辖范围（包括国际管辖范围）内，其归所有人拥有。Web 站点对任何本手册包含的第维能动不受能动的控制，科站点的内容不承担任何责任。如果您本手册中所涉有限公Web 站点，您必须自己承担由此带来的风险。及的第司提供这些能动的目的仅是为了提供方便，包含这些并不暗示能动有限公司对这些第站点上的内容负有或承担任何责任

3、。. Copyright 2005-2010能动，不得保留所利。能动的事先、影印、再版、翻译本手册的全部或部分内容，也不得将其转换为任何电子或机械可读的形式。能动EnableQ、EnableQ以及其保留在特别的前提前，更改及部分更改本手册相关内容的权利。Logo、文字标志和标识是能动的商标。EnableQ 2009 年引擎参考手册数据接口规范 第四版：2009 年 08 月问卷能动，。1. 适用系统或系统中集成 EnableQ 问卷管理功本手册适合于第开发商，在自有能，并能够利用现有用户认证系统实现与 EnableQ 之间的无缝挂接。2. 概览EnableQ 提供两种数据接口规范：1) 基于

4、EnableQ 系统问卷设计员角色的创建、登录等数据接口规范2)问卷的样本数据接口规范，主要针对“私有”问卷而言2.1 关于 hash安全通信识别码 hash在下述文档中，将多次对 hash 进行使用，hash 是 EnableQ 为保证设置的安全通信识别标记。安全而特别hash 的值hash 的值是基于产品安装序列号来进行计算的，而产品安装序列号是产品的唯一识别标识，它由 6 组随机的 6 位数字组成。hash = md5(产品序列号)产品序列号在 EnableQ 系统管理员界面“激活”功能查看。3. 系统问卷设计员操作数据接口EnableQ 系统用户存在五种角色，分别是系统管理员、超级问卷

5、员、问卷设计员、结果查看员以及问卷录入员。对于问卷设计员，可以在 EnableQ 系统中完成对于问卷创建、设计、预览、执行、结束、统计、分析、归档等全部问卷管理的全部功能。EnableQ 提供对于问卷设计员操作的以下数据接口：3.1 调用形式协议：http客户端调用方法：GET 方法请求 URL：参数与说明：运行的全路径/WebAPI/AjaxUserAPI.删除用户用户激活用户新增用户参数值或说明taskAddUserusername$_GETpassword$_GETadminrole$_GET(可选)用户类型，对应的值为：2:问卷设计员3:结果查看员4:问卷录入员5:超级问卷员group

6、name$_GET参数值或说明taskActiveUserusername$_GEThash$_GET返回值错误：false|Incorrect User Name正确：true参数值或说明taskCloseUserusername$_GEThash$_GET返回值错误：false|Incorrect User Name正确：true参数值或说明taskDeleteUserusername$_GEThash$_GET返回值错误：false|Incorrect User Name正确：true编辑用户属性用户登录3.2 特别说明3.2.1 hash 码安全与通信程序示例为确保数据安全，Enabl

7、eQ 不建议您把 hash 码直接放在页面内从而完成全部数据操作。参数值或说明taskUserLoginusername$_GETpassword$_GEThash$_GET返回值错误：false|Incorrect User Name false|No-Active User false|Incorrect Usassword正确：true参数值或说明taskEditUserusername$_GETnewname$_GETpassword$_GET(可选)adminrole$_GET(可选)用户类型，对应的值为：2:问卷设计员3:结果查看员4:问卷录入员5:超级问卷员groupname$_

8、GET(可选)用户分组名hash$_GET返回值错误：false|Incorrect User Name false|User Name is exist正确：true说明为空表示不修改(可选)用户分组名hash$_GET返回值错误：false|User Name is exist正确：true说明新增用户默认是激活状态数据通信可通过中间的程序来完成。的一般性建议是：1) 在需要通信的页面打开前在SES注入hash 值2) 从页面中获得username 与password 的值，传递给AJAX 的中间通信程序3) AJAX 程序，先判断比较hash 与SES中hash 值4) hash 值正确

9、后，通过打开URL 文件方法，传递给EnableQ 接口程序对应的值5)接口程序的执行结果，反馈给AJAX 程序，再送给通信页面处理AJAX 通信程序是这样的：一个通用的$hashCode = md5(产品序列号);header(Content-Type:text/html; charset=gb2312);if( $_SEShash = $hashCode )$ajaxURL= $ajaxURL .= ?task=AddUser;$ajaxURL.= &username=.$_GETusername; /自有AJAX 程序采用GET 方法$ajaxURL.= &password=.$_GET

10、password;$ajaxURL .= &hash=.$hashCode;$File = fopen($ajaxURL,r); /需要开启$buffer = ;$ajaxRtnContent = ;while ($buffer = fgets($File,4096).ini 中allow_url_fopen 选项$ajaxRtnContent = $ajaxRtnContent.$buffer;fclose($File); die($ajaxRtnContent);elsedie(false|EnableQ Security Violation);3.2.2 用户登录接口的特殊性因用户登录的

11、特殊性，特别是在跨域或跨主机的情况下，使用示例程序的通信方式，即使用file 或 fopen 打开器端运行，EnableQURL 的方式，来EnableQ 的用户登录接口，这种方式在服务仅分配 Ses给运行接口程序的服务器，IE 客户端并不能获得Ses。故对于用户登录接口的调用，需要强制向 IE 客户端送 HTML 代码，使客户端来调用程序接口，从而获得 Ses信息。以下两种方式可作为调用方式的参考：1) 在原有系统用户登录后的框架页面中，如下代码：2) 在同一同一主机情况下也可如下代码：script language=javascript src= ajaxSubmit(?task=User

12、Login&username=传入的用户名&password=传入的&hash=传入 hash 码,);4.样本数据接口规范EnableQ 系统的问卷分成公开、私有、令牌三种类型。对于“公开”类型的问卷，普通的网页浏览者可查看并可提交问卷。对于“令牌”问卷，即问卷设计为问卷指定一组数字或字符的“通关令牌”，只有输入正确的令牌的才可查看与提交问卷。“私有”问卷需先检查用户定的问卷提交条件的用户。只有正确的用户，并满足了问卷设计可能设才可查看到问卷信息与提交问卷数据。故样本数据接口规范主要针对“私有”问卷而言，EnableQ 提供的程序接口规范，不仅可使用现有的通行证系统对用户来进行认证，还可通过

13、接口程序返回用户属性信息数据，从而结合用户属性信息与问卷提交数据两组条件，共同对问卷数据做过滤与检索。EnableQ 提供了 4 种不同的的管理方法，他们分别是：基于 EnableQ 会员帐户认证的标准机制EnableQ 系统自带帐户管理功能，可以由管理员添加或由用户自行，从而获得认证信息，以对需要登录才能查看和提交的问卷进行。应用系统认证基于 ses、方式的同域第如果EnableQ 与其他已经带有认证功能的 web 应用系统运行于同一台服务器的同一下，则可以将登录认证交给该 web 应用系统进行处理。从而避免了多处认证。采用 Web Service 方式的第应用系统认证如果需要将Enable

14、Q 部署于单独的服务器上，而认证还需要使用第证，则可以采用 Web Service 方式达到这一目的。应用系统已有的认Active Directory 服务的应用系统认证基于对于的认证服务，如微软目录服务(持功能，保证了对用户已有认证系统的支持。Active Directory)，EnableQ 也提供了良好的支所以接口规范主要针对使用非 EnableQ 通行证体系的用户而言。4.1 基于 ses、方式的同域第应用系统认证EnableQ 提供了最简单的用户通行证接口规范，即通过 ses同服务器下的用户登录信息。、方式获得同在 EnableQ 系统中，您只需要简单指定原有通行证系统中标明用户登录

15、状态的变量名称等基本信息即可。EnableQ 从ses/中获取标明的两个变量的值，两值均为空的情形下，EnableQ登录。将提醒用户使用原系统进行对于利用原通行证登录的用户，EnableQ 将把自 ses称的变量名称”对应的值作为问卷回答的特殊标记/中获取的“标识会员名在单一样本的详细数据中。这种简单的用户通行证接口规范，将不能指定满足一定条件的用户才能提交问卷数据。对于用户的指定，仅区分是否拥有通行证。4.2 基于 Active Directory 服务的应用系统认证EnableQ 允许您通过Active Directory 活动目录系统对“私有”问卷进行用户认证。Active Direct

16、ory 所需要的最基本信息。您需要指定主域管理器等连接在上述前提下，EnableQ 允许您在编辑单一问卷的属性时，可指定Directory 内的部分用户(User)或用户组(Group)才可以进行问卷提交。Active并在展现问卷之前，先对用户进行认证，正确的也受到可提交条件的制约。4.3 采用 Web Service 方式的第应用系统认证为确保与您现有的通行证系统进行数据对接，EnableQ 提供了基于 Web Service 方式的第应用系统认证的数据接口规范。注：对于“设定私有问卷用户特征条件程序地址”若自身不带任何参数，请使用符号?结束4.3.1应用场景4.3.2 设定私有问卷用户特征

17、条件接口程序假设您不仅希望问卷只有在原有通行证系统内的合法用户才可以提交，还需要指定只有满足部分特征条件的用户，比如用户段、收入层次、来源地区等，才能真正获得问卷的提交资格。在此情形下，您除了需要指定该问卷的类型为“私有”之外，另需编写此接口程序。对于怎样来定义对于问卷的用户特定条件，EnableQ 实际上是不知情的，所以该接口程序需要您自己定义程序的用户交互界面，并可能需要您在原有通行证系统中创建一张或多数据表，用以该界面内的提交数据。EnableQ 传递给该接口程序所需要的三个参数：(调用方法：GET)surveyIDsurveyTitlehash问卷唯一标识 ID问卷的标题安全通信识别码

18、由此看来，该接口程序逻辑大致应该是这样的：接口程序适用应用场景设定私有问卷用户特征条件接口程序私有问卷可用来为单一私有问卷设定可提交的用户特征条件，通过对特征条件的定义，只有满足条件的用户 方可获取对该问卷真正合法提交；该程序不是必须的；与这个接口程序配套的，需要您在原有的关系型数据库中创建一张或多 ，用以 设定的用户特征条件与单一问卷的对应关系删除私有问卷用户特征条件接口程序私有问卷当用户在 EnableQ 系统中删除问卷后，该接口程序用来删除上一接口程序 在数据表内的用户特征条件与该问卷对应关系私有问卷提交检验用户 接口程序私有问卷用以检验用户 的 Web 接口程序，该程序用以检查提交问卷

19、的用户合 份，并且是接口所必须的；假设您还需要结合用户 上的属性信息，比如 、所在地区、学历信息等，与问卷本身的提交数据共同作为对问卷结果数据过滤检索与分析的条件，您还需要通过此接口程序返回这些属性数据以被 EnableQ 所单点登录返回用户属性数据接口程序私有问卷为满足在原有通行证系统已经完成用户登录，为避免在向用户展现问卷时再出现二次登录认证而编写，该程序也不是必须的。问卷提交完成后续处理逻辑接口程序私有问卷用户提交问卷，EnableQ 系统已经完成问卷数据 ，可利用该接口规范完成类似向原有用户体系内分配积分等其他后续逻辑处理下行单一用户问卷数据接口程序私有问卷可利用本接口规范自 Enab

20、leQ 系统下行某一用户的问卷全部数据至第 3 方系统1)2)3)4)判断接受的hash 是否正确；显示当前问卷的原设定提交条件；用户交互界面的操作信息，以修改数据表内的关闭当前窗口；注：-该接口程序的展现界面， EnableQ 系统是以 showModalDialog 方式在 700px * 500px的窗口内直接显示。因为模式窗口内的 Form 提交的特殊情况，故对程序编写有以下一般性建议：1) Form 的指向本页内隐藏的一个 iframe，比如：3) Form 提交后，处理正常的数据逻辑后，需要您在程序内关闭 EnableQ 这个模式窗口：echo self.close();-4.3.

21、3 删除私有问卷用户特征条件接口程序当用户在 EnableQ 系统中删除问卷或对问卷进行归档整理，该接口程序用来删除上一接口程序在数据表内的用户特征条件与该问卷对应关系。EnableQ 传递给该接口程序所需要的两个参数：(调用方法：GET)surveyIDhash问卷唯一标识 ID安全通信识别码由此看来，该接口程序逻辑大致应该是这样的：判断接受的hash 是否正确；删除数据表内列值等于问卷唯一标识 ID(surveyID)的数据4.3.4 私有问卷提交检验用户接口程序当问卷转为“执行”状态，EnableQ 在展现问卷之前，须先对用户进行认证。EnableQ就需要通过 AJAX 方式调用您编写的

22、检验用户的 Web 接口程序来完成该流程，并传递给该接口程序所需要的四个参数：(调用方法：GET)usernamepasswordsurveyIDhash用户输入的用户名用户输入的问卷唯一标识 ID安全通信识别码由前所述，该接口程序逻辑大致应该是这样的：1)2)3)4)判断接受的hash 是否正确；判断用户名/判断该用户基本用户是否正确；是否满足该问卷所设定的用户特征条件，该步骤不是必须的；返回需要返回的用户属性信息，该步骤也不是必须的接口程序需要返回给 EnableQ 的结果格式是：若错误，返回“false|错误信息”字符文本，以符号“|”作为返回信息的两段分割标记若正确：返回“true|用

23、户属性信息”字符文本，以符号“|”作为返回信息的两段分割标记注：-1)2)3)返回的 true 或 false 字符大小写是区分的。关于用户属性信息请参照 4.3.7 章节。如果您返回的数据中包含中文字符，可能需要先送一个数据包头：: header(content-type:text/html; charset=gb2312);ASP: Response.ContentType = text/html;charset=gb2312;4.3.5 单点登录返回用户属性数据接口程序由前面的阐述已经知道，EnableQ 在展现“私有”问卷时，须先对用户即先展示用户登录界面。进行认证，假设您希望在用户通

24、过原有通行证系统进行登录后，在原有用户操作界面中，新增一个该用户可提交的问卷列表工作界面，并通过点击列表中的某一问卷，该用户可直接查看到问卷并可提交，从而避免出现二次登录认证问题，您需要编写该接口程序。该程序实际上是上一接口程序的子集，它的程序逻辑大致应该是这样的：1)2)3)判断接受的hash 是否正确；判断该用户是否满足该问卷所设定的用户特征条件，该步骤不是必须的；返回需要返回的用户属性信息，该步骤也不是必须的在此逻辑基础上，EnableQ 提供给该接口程序所需要的三个参数：(调用方法：GET)usernamesurveyID用户名问卷唯一标识 ID3) hash安全通信识别码为确保该数据

25、接口规范的安全通讯，EnableQ给您的程序调用逻辑是：1) 在该页的尾部如下代码：2) 在该页的指向单一问卷的地址为：http:/ EnableQ 运行的全路径/x.或 http:/ EnableQ 运行的全路径/x.其中：用户名您可自原有系统的SES关于问卷唯一标识 ID?username=用户名&qid=该问卷唯一标识 ID?username=用户名&qname=该问卷唯一标识名信息内得到EnableQ 提供的设定私有问卷用户特征条件接口程序规范中，提供给您问卷唯一标识 ID，该程序规范要求您把其c) 关于问卷的标题在创建的新数据表内，该处可从新数据表中查询得到用户可提交的问卷列表会使用

26、到问卷标题，依照上述，也可从新数据表中查询得到工作机制-用户点击问卷列表工作界面内的问卷标题，会响应 EnableQ 安装服务器上的 x.接口程序，该程序自 GET 中得到您赋的 username 与 qid 两个值；2) x.会以得到的上述两值为基础，调用您编写的本接口程序，并以 GET 方式传递给该程序所需要的三个参数，以返回用户属性数据；3) 当返回值为 true 时，向用户展现可提交的问卷。-故该接口程序需要返回给 EnableQ 的结果格式是：若错误，返回“false|错误信息”字符文本，以符号“|”作为返回信息的两段分割标记若正确：返回“true|用户属性信息”字符文本，以符号“|

27、”作为返回信息的两段分割标记4.3.6 问卷提交完成后续处理逻辑接口程序用户提交问卷，EnableQ 系统已经完成问卷数据用户体系内分配积分等其他后续逻辑处理。，可利用该接口规范完成类似向原有EnableQ 传递给该接口程序所需要的五个参数：(调用方法：GET)surveyIDsurveyTitleownernameusernamehash问卷唯一标识 ID问卷标题问卷创建者的用户名回答问卷用户的用户名安全通信识别码假设您已经利用本数据接口规范，把 EnableQ 系统的问卷设计员与原有用户体系也一并进行整合，问卷创建者的用户名这个参数将可帮助您完成类似减少问卷创建者积分等逻辑处理。4.3.7用户属性与用户属性值若您需要结合用户上的属性信息，比如、所在地区、学历信息等，与问卷本身提交数据共同作为对问卷结果数据过滤、检索与分析的条件，您需要通过上述部分接口程序返回这些用户属性数据以被 EnableQ 所如“男”，为用户属性值。称用户属性，比如“”，对应的值，比EnableQ 允许您返回最多 6 个用户属性以及用户属性值的组合，以作为与问卷本身的提交数据共同作为对问卷结果数据过滤检索与