public interface ReportAdminServiceRemote extends AppServiceRemote
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
OUTPUT_FORMAT_HTML |
static java.lang.String |
OUTPUT_FORMAT_PDF |
static java.lang.String |
OUTPUT_FORMAT_XLS |
static java.lang.String |
OUTPUT_FORMAT_XLS_SPUDSOFT |
static java.lang.String |
OUTPUT_FORMAT_XLSX |
Modifier and Type | Method and Description |
---|---|
java.lang.Long |
addActiveThread(java.lang.String threadName,
java.lang.String reportName,
java.lang.String appName,
java.lang.String userName,
boolean scheduledJob)
Adds active thread information to the list of actively
running report threads.
|
void |
cancelReportJob(long reportJobId)
Cancels a report job identified by the reportJobId
|
void |
cancelReportJobOnThisServer(long reportJobId)
Cancels a report job identified by the reportJobId
|
void |
cleanupReportResources(ReportRunInfo reportRunInfo)
Removes all the temporary files created as part of the
prepareReportForRun method call.
|
void |
createReportDesign(UserInfo userInfo,
CreateReportInputInfo reportInputInfo)
Creates a report based on the input provided.
|
void |
createReportUsageLog(UserInfo userInfo,
ReportUsageLogInfo usageLogInfo)
Creates a report usage log entry based on the information provided.
|
java.lang.String |
exportLibraryImportInputInfo(UserInfo userInfo,
java.lang.String reportName)
Exports the information to be used as input to import the report library in XML format.
|
byte[] |
exportReport(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName)
Exports the report design and all resources.
|
java.lang.String |
exportReportImportInputInfo(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName)
Exports the information to be used as input to import the report in XML format.
|
byte[] |
exportReportLibrary(UserInfo userInfo,
java.lang.String reportName)
Exports the report library design and all resources.
|
java.lang.String |
getExportReportFolder(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName)
Returns the folder name to be used to export the report.
|
MboRemote |
getReport(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName)
Given the userInfo, reportName, and appName, return the report instance.
|
int |
getReportEngineState()
Returns the state of the report engine based on current activity and
the max concurrent reports setting.
|
java.util.ArrayList<java.lang.String> |
getReportLibraryNameList(UserInfo userInfo)
Returns a list of the report library names.
|
java.util.TreeMap<java.lang.String,java.util.List> |
getReportNameList(UserInfo userInfo)
Returns list of report names.
|
java.util.TreeMap<java.lang.String,java.util.List> |
getReportNameList(UserInfo userInfo,
int reportType)
Returns list of report names.
|
java.lang.String |
getReportViewerURL()
Returns the report viewer URL.
|
void |
importReport(UserInfo userInfo,
ReportImportInfo reportImportInfo,
boolean fromUI)
Imports the report information into appropriate tables in the database.
|
void |
importReportLibrary(UserInfo userInfo,
ReportImportInfo reportImportInfo)
Imports the report library information into appropriate tables in the database.
|
boolean |
isAuthorizedToRunReport(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName)
Returns whether the report is authorized for run or not.
|
boolean |
isOverloaded()
Returns whether the report engine is overloaded or not
(as set by the max concurrent reports setting).
|
boolean |
isReportJobCancelled(long reportJobId)
Returns true if the request report job is canceled, otherwise false.
|
ReportRunInfo |
prepareReportForRun(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName)
Prepares a report for run.
|
void |
removeActiveThread(java.lang.String threadName)
Removes the active thread information from the list of actively
running report threads.
|
void |
renewActiveThread(java.lang.String threadName)
Renews the lease information on the active thread.
|
byte[] |
runReport(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName,
ReportParameterData parameterData,
java.lang.String outputFileName,
java.lang.String outputFormat)
Executes the report and returns the report output in the appropriate
format.
|
byte[] |
runReport(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName,
ReportParameterData parameterData,
java.lang.String outputFileName,
java.lang.String outputFormat,
java.util.Map<java.lang.String,java.lang.Object> additionalInfoMap)
Executes the report and returns the report output in the appropriate
format.
|
byte[] |
runReportInImmediateMode(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName,
ReportParameterData parameterData,
java.lang.String outputFileName,
java.lang.String outputFormat)
Executes the report and returns the report output in the appropriate
format.
|
byte[] |
runReportInImmediateMode(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName,
ReportParameterData parameterData,
java.lang.String outputFileName,
java.lang.String outputFormat,
java.util.Map<java.lang.String,java.lang.Object> additionalInfoMap)
Executes the report and returns the report output in the appropriate
format.
|
java.lang.String |
runReportWithAttachments(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName,
ReportParameterData parameterData,
java.lang.String outputFileName,
java.lang.String outputFormat) |
void |
sendEmail(MXLogger logger,
UserInfo userInfo,
java.lang.String templateID,
java.lang.String[] to,
java.lang.String from,
MboRemote report,
TextReplacement replacer)
Sends and email using the given Comm Template Id for the provided userInfo and scheduled report instance.
|
void |
setActiveThreadsFromScriptContext(java.lang.String contextThreadName,
java.util.HashSet listOfActiveThreads)
Set the list of active threads from ScriptContext
|
void |
startBatchAllReportsImport(UserInfo userInfo,
boolean isSynchronous)
Import all reports.
|
void |
startBatchReportImport()
Import all reports which are not already imported.
|
void |
startBatchReportImport(boolean allTenants)
Import all reports which are not already imported.
|
byte[] |
updateReportDesign(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName,
boolean saveChanges)
Updates the report design with all identified fixes.
|
byte[] |
updateReportDesign(UserInfo userInfo,
java.lang.String reportName,
java.lang.String appName,
boolean saveChanges,
java.lang.String updateType)
Updates the report design with the identified fix, or all fixes if no update type
is provided.
|
checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser
isAppService, isSingletonService, restart
static final java.lang.String OUTPUT_FORMAT_PDF
static final java.lang.String OUTPUT_FORMAT_XLS
static final java.lang.String OUTPUT_FORMAT_XLSX
static final java.lang.String OUTPUT_FORMAT_XLS_SPUDSOFT
static final java.lang.String OUTPUT_FORMAT_HTML
void importReport(UserInfo userInfo, ReportImportInfo reportImportInfo, boolean fromUI) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportImportInfo
- report import information to be usedMXException
java.rmi.RemoteException
byte[] exportReport(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- report name to exportappName
- application name that the report belongs toMXException
java.rmi.RemoteException
byte[] exportReportLibrary(UserInfo userInfo, java.lang.String reportName) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- report library name to exportMXException
java.rmi.RemoteException
java.lang.String getExportReportFolder(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- report nameappName
- application name that the report belongs toMXException
java.rmi.RemoteException
java.lang.String exportReportImportInputInfo(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- report nameappName
- application name that the report belongs toMXException
java.rmi.RemoteException
java.lang.String exportLibraryImportInputInfo(UserInfo userInfo, java.lang.String reportName) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- report nameMXException
java.rmi.RemoteException
void importReportLibrary(UserInfo userInfo, ReportImportInfo reportImportInfo) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportImportInfo
- report import information to be usedMXException
java.rmi.RemoteException
java.util.ArrayList<java.lang.String> getReportLibraryNameList(UserInfo userInfo) throws MXException, java.rmi.RemoteException
userInfo
- user informationMXException
java.rmi.RemoteException
java.util.TreeMap<java.lang.String,java.util.List> getReportNameList(UserInfo userInfo) throws MXException, java.rmi.RemoteException
userInfo
- user informationMXException
java.rmi.RemoteException
java.util.TreeMap<java.lang.String,java.util.List> getReportNameList(UserInfo userInfo, int reportType) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportType
- the report type; report, QBR, or bothMXException
java.rmi.RemoteException
ReportRunInfo prepareReportForRun(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- report nameappName
- application name that the report belongs toMXException
java.rmi.RemoteException
void cleanupReportResources(ReportRunInfo reportRunInfo) throws MXException, java.rmi.RemoteException
reportRunInfo
- report run informationMXException
java.rmi.RemoteException
byte[] runReportInImmediateMode(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, ReportParameterData parameterData, java.lang.String outputFileName, java.lang.String outputFormat) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- report nameappName
- application name that the report belongs toparameterData
- parameter data to be used for the reportoutputFileName
- output file nameoutputFormat
- output formatMXException
java.rmi.RemoteException
byte[] runReportInImmediateMode(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, ReportParameterData parameterData, java.lang.String outputFileName, java.lang.String outputFormat, java.util.Map<java.lang.String,java.lang.Object> additionalInfoMap) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- report nameappName
- application name that the report belongs toparameterData
- parameter data to be used for the reportoutputFileName
- output file nameoutputFormat
- output formatadditionalInfoMap
- additional information to be passed to the report.MXException
java.rmi.RemoteException
byte[] runReport(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, ReportParameterData parameterData, java.lang.String outputFileName, java.lang.String outputFormat) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- report nameappName
- application name that the report belongs toparameterData
- parameter data to be used for the reportoutputFileName
- output file nameoutputFormat
- output format (OUTPUT_FORMAT_PDF or OUTPUT_FORMAT_HTML)MXException
java.rmi.RemoteException
byte[] runReport(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, ReportParameterData parameterData, java.lang.String outputFileName, java.lang.String outputFormat, java.util.Map<java.lang.String,java.lang.Object> additionalInfoMap) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- report nameappName
- application name that the report belongs toparameterData
- parameter data to be used for the reportoutputFileName
- output file nameoutputFormat
- output format (OUTPUT_FORMAT_PDF or OUTPUT_FORMAT_HTML)additionalInfoMap
- additional information to be passed to the report.MXException
java.rmi.RemoteException
java.lang.String runReportWithAttachments(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, ReportParameterData parameterData, java.lang.String outputFileName, java.lang.String outputFormat) throws MXException, java.rmi.RemoteException
MXException
java.rmi.RemoteException
boolean isOverloaded() throws MXException, java.rmi.RemoteException
MXException
java.rmi.RemoteException
int getReportEngineState() throws MXException, java.rmi.RemoteException
MXException
java.rmi.RemoteException
java.lang.Long addActiveThread(java.lang.String threadName, java.lang.String reportName, java.lang.String appName, java.lang.String userName, boolean scheduledJob) throws MXException, java.rmi.RemoteException
threadName
- name of the threadreportName
- report name being executed by the threadappName
- application name that the report belongs touserName
- user name (context in which the report is executed)scheduledJob
- a flag to indicate whether this is a scheduled job or not.MXException
java.rmi.RemoteException
void removeActiveThread(java.lang.String threadName) throws MXException, java.rmi.RemoteException
threadName
- name of the thread.MXException
java.rmi.RemoteException
void renewActiveThread(java.lang.String threadName) throws MXException, java.rmi.RemoteException
threadName
- name of the threadMXException
java.rmi.RemoteException
void setActiveThreadsFromScriptContext(java.lang.String contextThreadName, java.util.HashSet listOfActiveThreads) throws MXException, java.rmi.RemoteException
threadName
- name of the threadlistOfActiveThreads
- List of Active ThreadsMXException
java.rmi.RemoteException
void createReportUsageLog(UserInfo userInfo, ReportUsageLogInfo usageLogInfo) throws MXException, java.rmi.RemoteException
userInfo
- user informationusageLogInfo
- report usage log informationMXException
java.rmi.RemoteException
void createReportDesign(UserInfo userInfo, CreateReportInputInfo reportInputInfo) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportInputInfo
- input to create the reportMXException
java.rmi.RemoteException
boolean isAuthorizedToRunReport(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- name of the reportappName
- application for which the report belongsMXException
java.rmi.RemoteException
java.lang.String getReportViewerURL() throws MXException, java.rmi.RemoteException
MXException
java.rmi.RemoteException
void cancelReportJob(long reportJobId) throws MXException, java.rmi.RemoteException
reportJobId
- MXException
java.rmi.RemoteException
void cancelReportJobOnThisServer(long reportJobId) throws MXException, java.rmi.RemoteException
reportJobId
- MXException
java.rmi.RemoteException
boolean isReportJobCancelled(long reportJobId) throws MXException, java.rmi.RemoteException
reportJobId
- MXException
java.rmi.RemoteException
byte[] updateReportDesign(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, boolean saveChanges) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- name of the reportappName
- application name that the report belongs tosaveChanges
- should the update design be saved to the reportdesign tableMXException
java.rmi.RemoteException
byte[] updateReportDesign(UserInfo userInfo, java.lang.String reportName, java.lang.String appName, boolean saveChanges, java.lang.String updateType) throws MXException, java.rmi.RemoteException
userInfo
- user informationreportName
- name of the reportappName
- application name that the report belongs tosaveChanges
- should the update design be saved to the reportdesign tableupdateType
- the specific update to be applied, or all updates if nullMXException
java.rmi.RemoteException
void startBatchAllReportsImport(UserInfo userInfo, boolean isSynchronous) throws MXException, java.rmi.RemoteException
userInfo
- user informationMXException
java.rmi.RemoteException
void startBatchReportImport() throws java.rmi.RemoteException
java.rmi.RemoteException
void startBatchReportImport(boolean allTenants) throws java.rmi.RemoteException
allTenants
- in MT, imports for all tenants when true, and just DA and landlord when falsejava.rmi.RemoteException
void sendEmail(MXLogger logger, UserInfo userInfo, java.lang.String templateID, java.lang.String[] to, java.lang.String from, MboRemote report, TextReplacement replacer) throws java.rmi.RemoteException, MXException
logger
- logger to use for logging, can be null.userInfo
- optional userInfotemplateID
- Comm Template Idto
- array of "to" email addressesfrom
- from email addressreport
- Scheduled Report Instancereplacer
- Optional TextReplacement
instancejava.rmi.RemoteException
MXException
MboRemote getReport(UserInfo userInfo, java.lang.String reportName, java.lang.String appName) throws java.rmi.RemoteException, MXException
userInfo
- reportName
- appName
- java.rmi.RemoteException
MXException