Exporting job results with differences
The JobReport export type creates a summary of jobs, in which differences were detected or in which errors occurred during execution.
The generated output of the export can be either a CSV or JSON file.
In addition to the keys described in the Parameter file section, there are also other keys (listed below), which can be used for this specific export type.
Key Values
Dir
Relative path to the part of the Project tree that you want to export.
- If this key is empty (default value), the entire Project tree will be exported. (With the exception of the directories and components, to which the user carrying out the export has no access to).
- If the key is not empty, the entry must be preceded by a backslash (“”).
- The path of a component (with name) can also be entered.
Note
This key is ignored if a value is specified for ComponentID.
Example call:
Parameter file exportJobReport.ini
[Common]
ReportType=UnequalJobResults
ExportFile=D:TestmyJobReport.csv
Dir=SmartShopFloor
[User]
Account=
Password={Password}
List of attributes that can be found in the resulting file
| Column | Descriptio |
|---|---|
| Componen | Name of the component (including its path in the Project tree |
| ComponentI | ID of the component (in GUID format |
| ComponentTypeI | ID of the component type (in GUID format |
| ComponentTypeNam | Name of the component typ |
| JobI | ID of the job (in GUID format |
| JobNam | Name of the jo |
| UploadClas | Type of upload in use |
| WhoToNotif | Name of users that you want to be informed when the job is executed |
| WhoToNotifyName | Name of users that you want to be informed when a job is executedMultiple names must be separated by commas.This column is only displayed if sending emails has been configured as part of job executions. |
| WhoToNotifyEMail | Email addresses of octoplant users that you want to be informed when a job is executed.Multiple names must be separated by commas.This column is only displayed if sending emails has been configured as part of job executions. |
| WhoToNotifyAdditiona | Email addresses of users who do not have a octoplant account, but whom you still wish to inform when a job is executed.Multiple names must be separated by commas.This column is only displayed if sending emails has been configured as part of job executions. |
| Executio | Execution status of the jobThe following values are:0: Not according to a schedule1: According to a schedule2: Using the BackupClient |
| IpOrComputerNam | IP address or computer nameThe issued value depends on the upload class. |
| UploadAgen | Computer name or IP address of the agentThis value is only specified if an upload agent is assigned to the job. |
| CompareAgen | Computer name or IP address of the agentThis value is only specified if a compare agent is assigned to the job. |
| PendingResultCountDueUnequa | Number of job executions that have occurred since differences between the version on the device and the version on the server have been detected |
| PendingResultCountDueErro | Number of job executions that have occurred since an error was detected during the upload process |
| LastEqualDetection (local | Date of the last executed job that didn’t detect any differences between the version on the device and the version on the server (local time) |
| LastEqualDetection (UTC | Date of the last executed job that didn’t detect any differences between the version on the device and the version on the server (UTC) |
| NextStart (local | Time of next job start (local time |
| NextStart (UTC | Time of next job start (UTC |
| JobStart (local | Time at which the job execution was started (local time |
| JobStart (UTC | Time at which the job execution was started (UTC |
| JobFinish (local | Time when the job execution was finished (local time |
| JobFinish (UTC | Time when the job execution was finished (UTC |
| TimeStamp Backup (local | The backup timestamp (local time |
| TimeStamp Backup (UTC | The backup timestamp (UTC |
| TimeStamp PreBackup (local | The timestamp of the previous backup (local time |
| TimeStamp PreBackup (UTC | The timestamp of the previous backup (UTC |
Related Topics
Last update: September 15, 2023