BIEE常用的SOAP接口说明.doc

BIEE常用的SOAP接口说明BIEE常用的SOAP接口说明版本日期AMD修订者说明1.02010-07-295A吴军佑目录1.接口部份31.1biee登录接口31.2获取biee主题接口31.3获取表名接口51.4获取表结构81.5查询biee原报表91.6查询biee元数据111.7翻页接口122.数据结构描述131. 接口部份1.1 biee登录接口用于登录链接biee，获取会话id。【接口位置】com.tds.biee.service. LoginServiceImpl【函数说明】public String loginBieeExt(String username, String password, String userAgent,Locale locale)参数名类型最大长度说明usernameStringbiee登录帐号passwordStringbiee登录密码userAgentString获取操作系统类型和浏览器类型描述符localejava.util.Locale获取本地编码类型返回说明String登录成功biee返回的会话id调用例子String sessionId = bieeLoginService.loginBieeExt(cinfigBieeRec.getString(BIEE_LOGIN_ID),cinfigBieeRec.getString(BIEE_LOGIN_PWD),request.getHeader(User-Agent), request.getLocale();1.2 获取biee主题接口biee可以有多个主题域，每个主题载包含相关表。【接口位置】com.tds.biee.service. MetadataServiceImpl【函数说明】public SASubjectArea getSubjectAreas(String sessionID)参数名类型最大长度说明sessionIDString会话id返回说明SASubjectArea返回主题对象数据调用例子 MetadataService metadataService = (MetadataService) BasicFactory.getImpl(MetadataService.class); BieeAdressInfo bieeAdressInfo = new BieeAdressInfo(rec.getString(BIEE_IP),rec.getString(BIEE_LOGIN_PORT); metadataService.setBieeAdressInfo(bieeAdressInfo); SASubjectArea subjectAreaS = metadataService.getSubjectAreas(bieeSessionId); if(subjectAreaS != null & subjectAreaS.length0) querList = new ArrayList(subjectAreaS.length); for(int i=0; isubjectAreaS.length; i+) SASubjectArea subjectArea = subjectAreaSi; if(subjectArea != null) DataRecord dataSourceSubjectRec = new DataRecord(); dataSourceSubjectRec.setString(DATA_SOURCE_SUBJECT, subjectArea.getName(); dataSourceSubjectRec.setString(DATA_SOURCE_DISPLAY, subjectArea.getDisplayName(); dataSourceSubjectRec.setString(DATA_SOURCE_DESC, subjectArea.getDescription(); StringBuffer formatSelectResultBf = new StringBuffer(); formatSelectResultBf.append(TextUtil.replace(dataSourceSubjectRec.getString(DATA_SOURCE_SUBJECT), , ).append(&=); formatSelectResultBf.append(TextUtil.replace(dataSourceSubjectRec.getString(DATA_SOURCE_DISPLAY), , ).append(&=); formatSelectResultBf.append(TextUtil.replace(dataSourceSubjectRec.getString(DATA_SOURCE_DESC), , ); if(formatSelectResultBf != null) dataSourceSubjectRec.setString(DATA_SOURCE_FORMAT, formatSelectResultBf.toString(); querList.add(dataSourceSubjectRec); 1.3 获取表名接口获取biee主题中的表名。【接口位置】com.tds.biee.service. MetadataServiceImpl【函数说明】public SASubjectArea getSubjectArea(String areaName, SASubjectAreaDetails level, String sessionID)参数名类型最大长度说明areaNameStringbiee主题代码levelSASubjectAreaDetails指定所获取的主题域数据内容级别，如果只需要获取表,设置成SASubjectAreaDetails.IncludeTablessessionIDString会话id返回说明SASubjectArea返回包含所有表描述集合的biee主题对象调用例子 SASubjectArea resulSASubjectArea = new SASubjectArea(); for(int i=0; i + subjectArea.getName(); resulSASubjectArea = metadataService.getSubjectArea(subjectAreaSi.getName(), SASubjectAreaDetails.IncludeTables, bieeSessionId); break; LogU(resulSASubjectArea + resulSASubjectArea); LogU(resulSASubjectArea.getTables() + resulSASubjectArea.getTables(); if(resulSASubjectArea != null & resulSASubjectArea.getTables() != null & resulSASubjectArea.getTables().length0) SATable tables = resulSASubjectArea.getTables(); querList = new ArrayList(tables.length); for(int i=0; itables.length; i+) SATable table = tablesi; if(table != null & table.getName() != null) /过滤，根据表代码 if(!TextUtil.isEmpty(tableCode) & !TextUtil.isEmpty(table.getName() & table.getName().indexOf(tableCode)0) continue; /过滤，根据表名称 if(!TextUtil.isEmpty(tableName) & !TextUtil.isEmpty(table.getDisplayName() & table.getDisplayName().indexOf(tableName)0) continue; DataRecord tableRec = new DataRecord(); tableRec.setString(TABLE_CODE, table.getName(); tableRec.setString(TABLE_NAME, table.getDisplayName();1.4 获取表结构根据指定的biee主题和表代码获取表结构。【接口位置】com.tds.biee.service. MetadataServiceImpl【函数说明】public SAColumn describeColumn(String subjectAreaName, String tableName, String columnName,String sessionID)参数名类型最大长度说明subjectAreaNameStringbiee主题代码tableNameStringbiee 表代码columnNameStringbiee 表中的列名sessionIDString会话id返回说明SAColumn返回列对象调用例子 SAColumn columns = resultTable.getColumns(); if(columns = null | columns.length1) return null; querList = new ArrayList(columns.length); for(int i=0; i生成 where + conditionSql);elseconditionSql = getSqlCondition(rec, (List)tqConfigQueryRec.getObject(tqConditionConfigList), tableCode);LogU(生成 where + conditionSql);ViewService viewService = (ViewService) BasicFactory.getImpl(ViewService.class);BieeAdressInfo bieeAdressInfo = new BieeAdressInfo(tqConfigQueryRec.getString(BIEE_IP),tqConfigQueryRec.getString(BIEE_LOGIN_PORT);viewService.setBieeAdressInfo(bieeAdressInfo);LogU(makeQuerySQL开始查询* );String querySql = makeQuerySQL(rec, tqConfigQueryRec);if(!TextUtil.isEmpty(querySql) & !TextUtil.isEmpty(conditionSql)querySql += conditionSql;LogU(生成biee sql makeQuerySQL + querySql);reportXML = viewService.executeSQLQuery(querySql, 1000, bieeSessionId); / 只返回100页1.7 翻页接口翻页接口，在查询biee元数据时使用。【接口位置】com.siebel.analytics.web.XmlViewServiceSoapProxy【函数说明】public com.siebel.analytics.web.QueryResults fetchNext(java.lang.String queryID, java.lang.String sessionID)参数名类型最大长度说明queryIDString在执行查询biee元数据时设置的queryIDsessionIDString会话id返回说明QueryResults返回元数据对象调用例子Query query = this.queryService.get(queryConfigId);BieeConfig bieeConfig = bieeConfigService.get(query.getBieeConfigId();BieeAdressInfo bieeAdressInfo = new BieeAdressInfo();bieeAdressInfo.setBieeIp(bieeConfig.getBieeIp();bieeAdressInfo.setBieePort(bieeConfig.getPort();XmlViewServiceSoapProxy xmlClient = new XmlViewServiceSoapProxy(bieeAdressInfo);String sessionId = bieeSessionService.getSession(bieeConfig);LogU(fetchNexts