oracle.apps.fnd.appltest.diagfwk.engine
Class DiagCmdExtractReport

java.lang.Object
  oracle.apps.fnd.appltest.diagfwk.engine.DiagCmd<DiagCmdExtractReport.ReportWrapper>
      oracle.apps.fnd.appltest.diagfwk.engine.DiagCmdExtractReport

All Implemented Interfaces:

DiagConstants, DiagCmdConstants

public class DiagCmdExtractReport
extends DiagCmd<DiagCmdExtractReport.ReportWrapper>

Extracts the report(s) generated by a particular test run or execution. Provides options for the report(s) to be translated to a language as well as transformed to a specified presentation format (i.e. XML or HTML).

The command takes the following parameters:

• runid - Run ID for which to extract report. Reports for all the executions within this run are extracted to the destination directory.
• runName - Run name for which to extract report. Reports for all the execution within this run are extracted to the destination directory.
• execid - Execution ID for which to extract report. Reports for this execution and any nested executions are extracted to the destination directory.
• destdir - Destination directory where report files are written. If not specified the report files are extracted under [java.io.tmpdir]/[user.name]/diagfwk directory.
• format - XML or HTML. If XML, the reports are extracted in XML. If HTML, an additional XSL transformation is performed to create HTML reports. By default the value of this parameter is HTML.
• translate - Y or N. If set to "N", no translation is performed on the report. If "Y" then translation is performed on the report contents where applicable based on the value of the "lang" parameter. By default the value for this parameter is Y.
• lang - Language code for the language to which the report should be translated to when extracting. If a value is not specified, client's current session language is used as default. (note: this option is currently not implemented)
• writetofile - Y or N. If set to "Y", the generated report XML or HTML files are written to a specified location on the file system. Generally the CLI will always call this command with writetofile=Y hardwired. If set to "N" the report is fetched and translated in memory only and returned encapsulated within the output object. The ADF UI may call this command with writetofile=N so that files do not get written unnecessarily to the filesystem. The default value for this parameter is "N".
• makeSubDir - Y or N. If set to "Y" and writetofile is "Y", the generated report files will be created under a sub-directory of the destdir parameter. The sub-directory is generally the run GUID or the execution GUID. If set to "N" the report files are directly extracted to the destination directory. The default value for this parameter is "Y".

Since:

release specific (what release of product did this appear in)

Version:

$Header: atgpf/appltest/applications/Diagnostics/Engine/src/oracle/apps/fnd/appltest/diagfwk/engine/DiagCmdExtractReport.java /main/12 2009/06/05 14:18:09 ppradhan Exp $

Author:

ppradhan

Nested Class Summary

static class

DiagCmdExtractReport.ReportWrapper Models the output of this command.

Nested classes/interfaces inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

DiagConstants.ExecutionMode, DiagConstants.Format, DiagConstants.LinkType, DiagConstants.Status

Field Summary

Fields inherited from class oracle.apps.fnd.appltest.diagfwk.engine.DiagCmd

mParams

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.DiagCmdConstants

DELIM_VALUE, PARAM_APP, PARAM_CHILD_REPORTS, PARAM_CONNECT_STR, PARAM_DB_PWD, PARAM_DB_UN, PARAM_DESTDIR, PARAM_DIR, PARAM_EXEC_MODE, PARAM_EXECID, PARAM_FORMAT, PARAM_HELP, PARAM_LANG, PARAM_MAKESUBDIR, PARAM_MODID, PARAM_MODKEY, PARAM_NTHREADS, PARAM_PREREQ, PARAM_PRINTTOCONSOLE, PARAM_PRINTTREE, PARAM_PWD, PARAM_QUERY, PARAM_RECURSE, PARAM_REGISTER, PARAM_REPORT, PARAM_RUN_LOCALLY, PARAM_RUN_NAME, PARAM_RUNID, PARAM_RUNTEST, PARAM_STATUS, PARAM_TEST, PARAM_TESTFILE, PARAM_TOKEN_INPUT, PARAM_TOKEN_TAG, PARAM_TRANSLATE, PARAM_USERNAME, PARAM_VALIDATE_ONLY, PARAM_WAITFORCOMPLETION, PARAM_WRITETOFILE, PRE_POPULATED_EXECID

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

APPS_MSG_ID_TAG_NAME, CFG_ADR_PROVIDER_CLASS, CFG_CACHE_PROVIDER_CLASS, CFG_CRED_PROVIDER_CLASS, CFG_DAO_FACTORY_CLASS, CFG_DB_CONN_INFO_PROVIDER_CLASS, CFG_DB_CONN_PROVIDER_CLASS, CFG_NLS_PROVIDER_CLASS, CFG_PLSQL_PROVIDER_CLASS, CFG_PROFILE_PROVIDER_CLASS, CFG_SECURITY_PROVIDER_CLASS, CFG_SESSION_INFO_PROVIDER_CLASS, CFG_URL_PROVIDER_FACTORY_CLASS, CFG_WLS_MBEANSRV_CONNINFO_PROVIDER_CLASS, DATA_SECURITY_PERMISSION_ALLOWED, DATA_SECURITY_PERMISSION_NOT_ALLOWED, DELIM_URL, EXEC_MODE_CLI, EXEC_MODE_ESS, EXEC_MODE_INCIDENT, EXEC_MODE_JAVA, EXEC_MODE_UI, EXECUTABLE_TYPE_JAVA, EXECUTABLE_TYPE_PLSQL, EXECUTABLE_TYPE_TESTREF, FORMAT_HTML, FORMAT_XML, GUID_ORACLE_MINUS1, GUID_ORACLE_ZERO, INPUTS_STATUS_ALL_OPT_INPUTS, INPUTS_STATUS_NO_INPUTS, INPUTS_STATUS_REQ_INPUTS_NO_DEFAULTS, INPUTS_STATUS_REQ_INPUTS_W_DEFAULTS, IO_FLAG_I, IO_FLAG_O, JMX_API_BASE_OBJECT_NAME, LINK_EXTERNAL, LINK_INTERNAL, LINK_METALINK, N, NLS_BUNDLE_JAVA_RES, NLS_BUNDLE_MSG_SVC, NLS_BUNDLE_RES_REF, NLS_BUNDLE_XLIFF, NO, NULL, ODF_MBEAN_DOMAIN_NAME, PARAM_MON_INTERVAL, PLSQL_DEBUG_ENABLED_SYSTEM_PROP, PREREQ_TYPE_TAG_VALUE, PREREQ_TYPE_TEST, SECONDS_IN_ONE_DAY, SECONDS_IN_ONE_HOUR, STATUS_CANCELED, STATUS_EXECERROR, STATUS_FAILURE, STATUS_RUNNING, STATUS_SUCCESS, STATUS_WARNING, SYS_PROP_MAX_MONITOR_INTERNVAL, SYS_PROP_MAX_NUM_THREADS, SYSPROP_APPCONNFILE, SYSPROP_DIAG_CONFIG_FILE, TAG_TYPE_DIAG, TAG_TYPE_TAXONOMY, TEST_TYPE_DECL, TEST_TYPE_JAVA, USER_NAME, WEB_APP_NAME_TAG_NAME, Y, YES

Constructor Summary

DiagCmdExtractReport()

Method Summary

DiagCmdExtractReport.ReportWrapper	execute() Executes the current command with the parameters set by calling "setParams" method.
void	setExecReportLinkProvider(TestRun.ExecReportLinkProvider provider) Allows clients to programmatically set a custom link provider for execution reports when extracting run reports.

Methods inherited from class oracle.apps.fnd.appltest.diagfwk.engine.DiagCmd

addUpdateParam, getIntParam, getParam, getParam, getParam, getParams, getPosIntParam, getYNFlagParam, isParamName, logParams, setParams, tokenize, validateExactlyOneReqParam

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiagCmdExtractReport

public DiagCmdExtractReport()

Method Detail

setExecReportLinkProvider

public void setExecReportLinkProvider(TestRun.ExecReportLinkProvider provider)

Allows clients to programmatically set a custom link provider for execution reports when extracting run reports. If no such provider is set, the command will use a default provider that creates html links.

Parameters:

provider - an instance of execution report link provider.

execute

public DiagCmdExtractReport.ReportWrapper execute()

Description copied from class: DiagCmd

Executes the current command with the parameters set by calling "setParams" method.

Specified by:

execute in class DiagCmd<DiagCmdExtractReport.ReportWrapper>

Returns: