exportJobConsole

Exports the job console records to a CSV file and creates an export ZIP file.

The first character in the output CSV file is the Byte Order Mark (BOM) character \ufeff followed by an encrypted application identifier enclosed in double quotes. CSV file header follows the application identifier.

Applies to

Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management, Oracle Strategic Workforce Planning Cloud, and Oracle Sales Planning Cloud.

Required Roles

Service Administrator

Usage

epmautomate exportJobConsole FILE_NAME.zip [nDays=NUMBER_OF_DAYS] [jobtypes=JOB_TYPE] [jobStatusCodes=STATUS_CODE] [exportErrorDetails=true|false] [excludeApplicationId=true|false], where:
  • FILE_NAME is the name of the ZIP file that will store the exported job console records. You use the downloadFile command to download this file from an environment.
  • nDays, optionally, identifies the number of days for which job console records are to be exported. Possible values are: all (in all lower case)to export all available job console records, 1, 2, 7, 30, and 60. Default is 7.
  • jobTypes, optionally, is a comma separated list of job codes for which console records should be exported. Default is Rules. Valid values are:
    • all (in all lower case)
    • RULES
    • RULESET
    • CLEAR_CELL_DETAILS
    • COPY_DATA
    • INVALID_INTERSECTION_RPT
    • COPY_VERSIONS
    • CONTENT_UPGRADE
    • PLAN_TYPE_MAP
    • IMPORT_DATA
    • EXPORT_DATA
    • EXPORT_METADATA
    • IMPORT_METADATA
    • CUBE_REFRESH
    • CLEAR_CUBE
    • ADMIN_MODE
    • COMPACT_CUBE
    • RESTRUCTURE_CUBE
    • MERGE_DATA_SLICES
    • OPTIMIZE_AGGREGATION
    • SECURITY_IMPORT
    • SECURITY_EXPORT
    • AUDIT_EXPORT
    • JOBCONSOLE_EXPORT
    • SORT_MEMBERS
    • SMART_PUSH
    • IMPORT_EXCHANGE_RATES
  • jobStatusCodes, optionally, is a comma-separated list of job status codes for which records are to be exported. Default is 2 (Completed Successfully). Possible values are:
    • all (in all lower case) for all jobs in any status
    • 1 - Processing
    • 2 - Completed successfully
    • 3 - Failed with errors
    • 4 - Completed with unknown status
    • 5 - Completed with threshold violation status
    • 6 - Pending cancellation
    • 7 - Cancelled
    • 8 - Completed with errors
    • 9 - Completed with warnings
  • exportErrorDetails , optionally, exports the details of jobs that failed or reported error to log files if this value is set to true. This error log file is included in the output ZIP file. Default is false. If this value is set to true, status details of jobs in the following status are exported.
    • Failed with errors
    • Completed with unknown status
    • Completed with threshold violation status
    • Completed with errors
    • Completed with warnings
  • excludeApplicationId, optionally identifies whether the application identifier is to be written to the export file. Default is false.

    Note:

    Data from exported files that do not contain the application identifier cannot be imported into Oracle Enterprise Performance Management Cloud environments.

Examples

  • Export all available job console records:

    epmautomate exportJobConsole jobs.zip nDays=all jobTypes=all jobStatusCodes=all

  • Export all available Rules job console records:

    epmautomate exportJobConsole jobs.zip nDays=all jobStatusCodes=all

  • Export all available Rules job console records without application identifier:

    epmautomate exportJobConsole jobs.zip nDays=all jobStatusCodes=all excludeApplicationId=true

  • Export only the records for Rules job that finished successfully in the last 14 days:

    epmautomate exportJobConsole jobs.zip nDays=14

  • Export console records and errors of import metadata and clear cube jobs that failed with errors or completed with errors run in the last seven days:

    epmautomate exportJobConsole jobs.zip jobtypes=IMPORT_METADATA,CLEAR_CUBE jobStatusCode=3,8 exportErrorDetails=true