Export Job Console

Comma-separated job codes for which job console records should be exported. Possible values are:

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request specific to this job. For parameters that are generic to all jobs, see Execute a Job.

Table 5-27 Parameters

Name Description Required Default
jobType Export Job Console Yes None
jobName The job name to be used for this job execution. Example: ExportWeeklyJobStatusRecords No Export Job Console
userNames Comma separated user names. Job console records created by only the specified users are exported. If not specified, job console records created by all users are exported. No None
fileName

The name of the file to which records should be exported. The file containing the exported data is stored in the Planning repository.

If fileName is not specified, a file is auto-generated with a name containing the user name, current date, and time stamp. For example, test_admin_JobConsoleRecords_2019-02-26-04-34-45-420.zip

No The file name is auto-generated
ndays Number of days for which audit records should be exported.

Possible values are.

  • 1: Export job console records for the last 24 hours
  • 2: Export job console records for the last two days
  • 7: Export job console records for the last seven days
  • 30: Export job console records for the last 30 days
  • 60: Export job console records for the last 60 days
  • 180: Export job console records for the last 180 days
  • All: Export all job console records
No 7
jobNames Comma-separated job names for which job console records should be exported. No None
jobTypes Comma-separated job codes for which job console records should be exported.

Possible values are:

  • ALL
  • Rules or RULES
  • Ruleset or RULESET
  • Clear Cell Details or CLEAR_CELL_DETAILS
  • Copy Data or COPY_DATA
  • Invalid Intersection Report/INVALID_INTERSECTION_RPT
  • Copy Versions or COPY_VERSIONS
  • Content Upgrade or CONTENT_UPGRADE
  • Plan Type Map or PLAN_TYPE_MAP
  • Import Data or IMPORT_DATA
  • Export Data or EXPORT_DATA
  • Export Metadata or EXPORT_METADATA
  • Import Metadata or IMPORT_METADATA
  • Cube Refresh or CUBE_REFRESH
  • Clear Cube or CLEAR_CUBE
  • Administration Mode or ADMIN_MODE
  • Compact Cube or COMPACT_CUBE
  • Restructure Cube or RESTRUCTURE_CUBE
  • Merge Data Slices or MERGE_DATA_SLICES
  • Optimize Aggregation or OPTIMIZE_AGGREGATION
  • Import Security or SECURITY_IMPORT
  • Export Security or SECURITY_EXPORT
  • Export Audit or AUDIT_EXPORT
  • Export Job Console or JOBCONSOLE_EXPORT
  • Sort Members or SORT_MEMBERS
No Rules
jobStatusCodes Comma-separated status code of the jobs for which job records are exported. Possible values are:
  • 1 Processing: Current jobs under execution
  • 2 Completed: Successfully completed jobs
  • 3 Error: Jobs failed with errors
  • 4 Unknown: Jobs completed with unknown status
  • 5 Completed with Threshold Violation: Jobs completed with threshold violation status
  • 6 Pending Cancel: Jobs with Pending cancel status
  • 7 Cancelled: Cancelled jobs
  • 8 Completed with Errors: Jobs completed with errors
  • 9 Completed with Warnings: Jobs completed with warnings all
  • all All: Export the jobs with any status
No 2
exportErrorDetails

If true, exports the details of failed/error jobs as separate error log file in the final output file.

Job status details of jobs having one of the status listed below are exported in separate files.

  • Error
  • Unknown
  • Completed with Threshold Exception
  • Completed with Errors
  • Completed with Warnings
No true

Sample Payload

Example 1: Exports the job console records for all default parameters into the NewFile.csv file. Exports status of all Rule jobs completed in the last seven days.

{
     "jobType":"JOBCONSOLE_EXPORT",
     "jobName":"AllJobConsoleExports",
     "parameters":{"fileName":"NewFile.csv"}
}

Example 2: Exports the job console records for Rule and Export Data jobs that completed normally or with an error status over the last month into the exportFile.csv file. Job details of the failed jobs are exported in separate files in the final compressed file.

{
     "jobType":"JOBCONSOLE_EXPORT",
     "parameters":{"fileName":"exportFile.csv", "jobTypes": "Rules, EXPORT_DATA", "jobStatus": "2,3", "ndays":"30"}
}

Example 3: Exports the job console records for the jobs named Daily Consolidation and Smart Push to a Reporting Cube. Includes jobs that completed normally or with an error status over the last month into the exportFile.csv file. Job details of the failed jobs are not exported because exportErrorDetails is false.

{
     "jobType":"JOBCONSOLE_EXPORT",
     "parameters":{"fileName":"exportFile.csv", "jobNames":"Daily Consolidation, Smart Push to Reporting Cube", "jobStatus": "2,3", "ndays":”30", "exportErrorDetails":"false"}
}