如何通过Java SDK程序化获取Cognos 11.1.7报表元数据

1. 环境依赖 #

• 从Cognos安装目录的webapps/p2pd/WEB-INF/lib下引入核心JAR包：axis.jar、axisClient.jar、CAMBridge.jar、CognosSDK.jar等
• 配置JVM参数指定Cognos服务地址：-Dcom.cognos.developer.schemas.bibus.namespace=http://<cognos-server>:<port>/p2pd/servlet/dispatch

2. 连接Cognos服务器 #

通过CAMBridge建立会话，完成登录验证：

import com.cognos.developer.schemas.bibus._3.*;
import org.apache.axis.client.Stub;

public class CognosConnector {
    private static BIBusHeader biBusHeader;
    private static ContentManagerService_PortType cmService;

    public static void connect(String cognosUrl, String username, String password, String namespace) throws Exception {
        // 初始化内容管理服务端口
        ContentManagerService serviceLocator = new ContentManagerServiceLocator();
        cmService = serviceLocator.getcontentManagerService();
        ((Stub) cmService).setTargetEndpointAddress(cognosUrl + "/p2pd/servlet/dispatch");

        // 构造登录凭证
        CAM cam = new CAM();
        UserCredentials credentials = new UserCredentials();
        credentials.setUserID(username);
        credentials.setPassword(password);
        credentials.setNamespace(namespace);
        cam.setUserCredentials(credentials);

        // 设置会话头并登录
        biBusHeader = new BIBusHeader();
        biBusHeader.setCAM(cam);
        ((Stub) cmService).setHeader(new BIBusHeaderElement(biBusHeader));
        cmService.logon(null);
    }
}

3. 查询指定包内的所有报表ID #

通过search方法过滤包下类型为report的对象，提取ID：

import java.util.ArrayList;
import java.util.List;

public static List<String> getReportIdsInPackage(String packagePath) throws Exception {
    List<String> reportIds = new ArrayList<>();
    // 搜索路径格式："/content/folder[@name='包所在文件夹']/package[@name='目标包']/*[@class='report']"
    SearchPathMultipleObject searchPath = new SearchPathMultipleObject(packagePath + "/*[@class='report']");
    // 指定要获取的属性：名称、搜索路径、对象ID
    PropEnum[] properties = {PropEnum.defaultName, PropEnum.searchPath, PropEnum.objectID};
    BaseClass[] results = cmService.search(searchPath, properties, new Sort[]{}, new QueryOptions());

    for (BaseClass obj : results) {
        Report report = (Report) obj;
        reportIds.add(report.getObjectID().getValue());
    }
    return reportIds;
}

4. 根据报表ID获取元数据 #

使用retrieve方法拉取报表的标题、描述、pathref等属性：

public static ReportMetadata getReportMetadata(String reportId) throws Exception {
    SearchPathSingleObject reportPath = new SearchPathSingleObject("report[@objectID='" + reportId + "']");
    PropEnum[] targetProps = {
        PropEnum.objectID,
        PropEnum.defaultName,  // 报表标题
        PropEnum.description,  // 报表描述
        PropEnum.searchPath    // PathRef
    };

    BaseClass[] retrieved = cmService.retrieve(reportPath, targetProps, new QueryOptions());
    Report report = (Report) retrieved[0];

    ReportMetadata metadata = new ReportMetadata();
    metadata.setId(report.getObjectID().getValue());
    metadata.setTitle(report.getDefaultName());
    metadata.setDescription(report.getDescription() != null ? report.getDescription() : "");
    metadata.setPathRef(report.getSearchPath().getValue());

    return metadata;
}

// 自定义元数据实体类
class ReportMetadata {
    private String id;
    private String title;
    private String description;
    private String pathRef;

    // 生成getter、setter方法
    // ...
}

5. 导出元数据到CSV文件 #

处理CSV格式转义，避免逗号、引号破坏文件结构：

import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.List;

public static void exportToCsv(List<ReportMetadata> metadataList, String outputPath) throws IOException {
    try (PrintWriter writer = new PrintWriter(new File(outputPath))) {
        // 写入CSV表头
        writer.println("报表ID,标题,描述,PathRef");

        // 逐行写入数据
        for (ReportMetadata meta : metadataList) {
            writer.printf("%s,%s,%s,%s%n",
                meta.getId(),
                escapeCsvField(meta.getTitle()),
                escapeCsvField(meta.getDescription()),
                meta.getPathRef());
        }
    }
}

// 处理CSV字段的特殊字符转义
private static String escapeCsvField(String field) {
    if (field == null) return "";
    if (field.contains(",") || field.contains("\"") || field.contains("\n")) {
        return "\"" + field.replace("\"", "\"\"") + "\"";
    }
    return field;
}

6. 命令行工具整合 #

解析命令行参数，串联所有逻辑：

public class CognosReportExporter {
    public static void main(String[] args) {
        if (args.length != 6) {
            System.err.println("用法: java CognosReportExporter <Cognos服务地址> <用户名> <密码> <命名空间> <包完整搜索路径> <输出CSV路径>");
            System.exit(1);
        }

        try {
            // 连接Cognos服务器
            CognosConnector.connect(args[0], args[1], args[2], args[3]);
            // 获取包内报表ID列表
            List<String> reportIds = CognosConnector.getReportIdsInPackage(args[4]);
            // 批量获取元数据
            List<ReportMetadata> metadataList = new ArrayList<>();
            for (String id : reportIds) {
                metadataList.add(CognosConnector.getReportMetadata(id));
            }
            // 导出到CSV
            CognosConnector.exportToCsv(metadataList, args[5]);

            System.out.println("导出完成，共处理 " + metadataList.size() + " 个报表");
        } catch (Exception e) {
            System.err.println("执行出错: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

注意事项 #

• Cognos服务地址格式通常为http://<server>:9300，确保/p2pd/servlet/dispatch可访问
• 登录用户需拥有目标包及报表的浏览权限
• 报表数量较大时，可通过QueryOptions设置pageSize和pageNumber实现分页查询，避免内存溢出

内容的提问来源于stack exchange，提问作者Gregory Williams