自定义任务开发指南

//相当于: var frame = new Packages.java.io.File("filename");
var frame = java.io.File("filename");

importClass (java.io.File);
var file = File("filename");

importPackage(java.io);

var file = File("filename");

var MyImport = JavaImporter(java.io.File);
with (MyImport) {
var myFile = File("filename");
}

importPackage(Packages.tony);
var hello = HelloWorld();
hello.sayHello();

对象

对象描述

connector

系统内置的连接对象，连接到计划任务服务器，可直接使用。例如：

• 在SDK对象中调用： var tempReport = new Report(connector);
• 在任务组件中调用：
  
  var tempResourceHandle = execute("openResource", {
  clientConnector: connector,
  reportId: "xxxxxxxxxxx"
  });
• 调用扩展包中的module方法，这样逻辑复杂可以考虑写在扩展包，任务直接调用：
   connector.remoteInvoke("CustomModule", "syncLDAPUsers", []); //后面中括号是参数,有的话就传,没有的话就是个空数组 

logger

系统内置的写日志对象。有三个方法：

• logger.debug
• logger.error
• logger.info

execute

execute函数用于执行内置任务组件，一般可以通过任务配置界面配置，然后查看运行脚本看execute的示例，详见任务组件说明。

服务对象

描述

AnalysisReportService

提供多维分析相关操作功能

CatalogService

提供资源目录树的访问功能等

GraphicReportService

提供图形分析报表访问功能

ManageReportService

提供业务报表相关操作功能

UserManagerService

提供用户相关操作。包括：读取/维护用户信息、读取/维护组信息、读取/维护角色信息、为用户和组分配角色等

说明

调用接口

读取资源节点

var reportId = 'I2c9410a623cc37d10123cc8f90930187';
 var catalogService = new CatalogService(connector);
 var reportElem = catalogService.getCatalogElementById(reportId);
 var reportAlias = reportElem.getAlias();

创建资源定义

多维分析

var tempReportService = new AnalysisReportService(connector);
var clientId = tempReportService.openAnalysisReport(reportId)

电子表格

var tempReport = new SSReport(connector);
tempReport.open(reportId);

参数相关

电子表格

//获取参数列表 

var paramList = tempReport.getParamList();

 //设置参数值 
tempReport.setParamValue(param.id, param.value, param.displayValue);

多维分析

var paramList = tempReportService.getParameters(clientid);
tempReportService.setParamValue(clientId, param.id, param.value, param.displayValue);
var enumParamValues = tempReportService.getParamStandbyValue(clientId, param.id);

刷新报表

多维分析

tempReportService.executeQuery(clientId)

电子表格

无接口，导出时会自动刷新报表。

导出报表到本地文件

多维分析

//第二个参数为String类型，表示导出格式，支持格式为EXCEL、CSV、TXT、PDF、WORD； 
tempReportService.doExport(clientId, 'MHT', ',' , outputStream, '');

电子表格

//第二个参数为String类型，表示导出格式，支持格式为PDF、PNG、WORD、EXCEL、EXCEL2007、HTML； 
tempReport.export('EXCEL', outputStream);

// 导入将会使用的java类与java包
importClass(java.lang.System);
importPackage(Packages.smartbi.sdk.service.simplereport);

// 创建分析查询对象
var reportId = 'I2c949e8e1ac2d5e6011ac380971301b8';
var tempReportService = new SimpleReportService(connector);
var tempReport = tempReportService.openReport(reportId);
// 执行分析报表，获取总行数
var totalRow = tempReport. execute(100);
tempReport.close();

logger.info('总行数为: '+ totalRow);

Execute命令解释

Input输入参数

Output输出结果

OpenResource
打开资源组件，可以打开任意组件类型。

• connector：客户端连接对象。
• reportId：String类型，报表资源的ID。

• resourceHandle：资源句柄。

EnumerateParamValues
参数枚举组件。

• resourceHandle：系统连接对象。
• byEveryParam：boolean类型，是否枚举true/flase。
• paramsSetting：IParamValue[]，参数缺省值。

• getParamValues：获得参数枚举值的迭代器。

FillData
填充数据组件。

• connector：客户端连接对象。
• tableId：String类型，表ID。

• isSucceeded：是否成功。

ExportResource
导出资源组件。 根据输入的参数迭代器，可以导出一份或多份参数组合的报表执行结果。

• connector：客户端连接对象。
• resourceHandle：资源句柄。
• paramSettingIterator：参数迭代器。
• exportSetting：IExportSetting类型，导出设置。
  
  • delimiter：String类型，分隔符。
  • folderDepth：int类型，目录深度。
  • height：String类型，用于仪表分析设置高度。
  • paramValueTypeInReportName：String。
  • pathId：String类型，路径。
  • resourceBasePath：String类型。
  • userDefinedFolderName：String类型，用于指定目录名。
  • width：String类型，用于仪表分析设置宽度。
• taskName：String类型，任务名。
• exportType：String类型，导出类型。

• file：输出的临时文件。
• folder：输出的临时目录。

SendToFile
发送到文件组件。

• file：File[]类型，要发送的文件。
• sendSetting：ICopySetting类型，发送设置。
  
  • filename：String类型，目标文件名。
  • path：String类型，目录路径。

• 无。

SendToMail
发邮件组件。

• connector：客户端连接对象。
• files：File[]类型，要发送的邮件附件列表。
• paramValueMap：String类型，参数值。
• sendSetting：IMailSetting类型，发邮件设置信息。
  
  • doZip：boolean类型，是否压缩。
  • mailList：String类型，收件人地址列表，用分号（;）分隔。
  • ccMailList：String类型，抄送地址列表，用分号（;）分隔。
  • bccMailList：String类型，密送地址列表，用分号（;）分隔。
  • text：String类型，邮件正文。
  • title：String类型，邮件标题。
• taskName：String类型，任务名。

• 无。

//初始化参数设置：枚举"产品目录参数"，固定"开始日期"和"结束日期"参数值。
var reportParamSetting = [
{id:"OutputParameter.I2c90903e114ef1af01114f2ed1e40097.产品目录参数", value:"$枚举值$",displayValue:"$枚举值$"},
{id:"OutputParameter.I2c90903e114ef1af01114f2ed1e40097.开始日期", value:"1996-01-17",displayValue:"1996-01-17"},
{id:"OutputParameter.I2c90903e114ef1af01114f2ed1e40097.结束日期", value:"2011-03-03",displayValue:"2011-03-03"}
];

//打开报表资源。
var tempResourceHandle = execute("openResource", {
clientConnector: connector,
reportId: "I2c90903e114f6f9601114f70e09d000e"
});

//设置报表参数。
var enumerateParamValuesOutput = execute('enumerateParamValues', {
resourceHandle: tempResourceHandle.resourceHandle,
byEveryParam: true,
paramsSetting: reportParamSetting
});

//以EXCEL格式导出报表资源。
var exportReportOutput = execute('exportResource', {
connector: connector,
resourceHandle: tempResourceHandle.resourceHandle,
paramSettingIterator: enumerateParamValuesOutput.getParamValues(),
exportSetting: {"delimiter":"", "pathId":""},
taskName: taskName,
exportType: "EXCEL"
});

//输出文件到C:/task/目录。
var outputFile = exportReportOutput.folder;
var sendToFileOutput = execute('sendToFile', {
file: outputFile,
sendSetting: {path: ' C:/task/'}
});