Utility - simpleExportComplianceRun

Utility - simpleExportComplianceRun

Description :

This command exports the results of a Compliance Job run to a file and gives you more control over the resulting output than other similar commands. You must identify the job run by its run number. The result is in a CSV format.

Return type : java.lang.Void

Command Input :

Variable Name

Variable Type

Description

templateGroupName

String

Fully qualified component template group containing the template that is the basis of the Compliance Job. Alternatively, you can pass in null for all results.

templateName

String

Name of the component template specifying the Compliance Job results to be exported. Alternatively, you can pass in null for all results.

ruleName

String

Fully qualified path of the rule of the Compliance Job results to be exported. Alternatively, you can pass in null for all results.

jobGroupName

String

Fully qualified job group where the Compliance Job is stored.

jobName

String

Name of the Compliance Job to export.

runId

Integer

Job Run Id of the Compliance Job run to export.

exportFileName

String

Name of the file that holds the export.

Example

The following example shows how to export the job run result of a Compliance Job. To prepare for the export, we first get the job key, and use it to get the job run key; we then convert the job run key to a job run ID, and then we are finally ready to run the export command.

Script

JOB_DB_KEY=`blcli ComplianceJob getDBKeyByGroupAndName "/sampleJobGroup" "sampleJob"`

JOB_RUN_KEY=`blcli JobRun findAllRunKeysByJobKey $JOB_DB_KEY`

JOB_RUN_ID=`blcli JobRun jobRunKeyToJobRunId $JOB_RUN_KEY`

COMPLIANCE_JOB_RUN_EXPORT=`blcli Utility simpleExportComplianceRun "/sampleTemplateGroup" "sampleTemplate" "/sampleRuleGroup/sampleRule" "/sampleJobGroup" "sampleJob" $JOB_RUN_ID "C:/temp/sampleJobResult.csv"`
Was this page helpful? Yes No Submitting... Thank you

Comments