KB-126934: Exporting job results

Exporting job results

When exporting of the JobResults type, an overview of the job results of all jobs is created.

The export can be output either as a CSV or JSON file.

Note

The job results of already deleted jobs are not listed.

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.

Section [Common]

Key Value

Dir

Relative path to the part of the Project tree that you want to be exported.

  • If this key is empty (default value), the whole 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 (“”).
  • It is also possible to enter the path of a component (with its name).

Note

This key will be disregarded if a value is entered for “ComponentID”.

Section [Filter]

Key Value

FilterFrom

Start of the time period according to which entries are to be filtered (as a timestamp in UTC format).

To output only the differences to the last export, you can specify the value “LastExecution” here. Under this key, the timestamp of the last executed export will be entered in the [Result] section.

FilterTo End of the time period according to which entries are to be filtered (as a timestamp in UTC format).

LastXDays Period (in days) after which entries are to be exported

Example call:

VDogAutoExport.exe "/rd:D:vdClientArchive" "/CFile:D:TestexportJobResults.ini"

Parameter file CiCoLog.ini

[Common]
ReportType=JobResults
ExportFile=D:TestmyJobResults.csv
Dir=SmartShopFloor
[Filter]
LastXDays=20
[User]
Account=
Password={Password}

List of attributes that can be found in the resulting file

The data records are sorted by the contents of the JobId column and the TimestampUTC column.

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 Upload type of the jo
WhoToNotif List of users to be notified about the job executio
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 value issued is dependent on the upload class
UploadAgen Name or IP address of agentThis value is only issued when an upload agent is assigned to the job
CompareAgen Name or IP address of agentThis value is only issued when an upload agent is assigned to the job
TimestampLoca Timestamp of the version (local time
TimestampUT Timestamp of the job execution (UTC
TimeStampBackupLoca Timestamp of the Backup.zip file (local time
TimeStampBackupUT Timestamp of the Backup.zip file (UTC
DirBacku The relative path of the directory, in the server archive, where the current backup of the job (Backup.zip file) was stored
ResultVersionVsBacku Result of the comparison between the version on the server and the backup.A list of issued status codes and their descriptions can be found in the Job results section, located in the AdminClient tutorial.The following job execution results are not displayed in this export:Not presentDeactivated
TimestampVersionLoca Timestamp of the Archive.zip file (local time
TimestampVersionUT Timestamp of the Archive.zip file (UTC
DirVersio The relative path of the directory in the server archive where the current backup of the job (Archive.zip file) was stored
VersionNumbe Version numbe
ErrorVersionVsBacku The column only contains a value if an error occurred when comparing Server version ↔ Backup
WarningVersionVsBacku The column only contains a value if an error occurred when comparing Server version ↔ Backup
ResultBackupVsPreBacku The result of the comparison between the current and previous backup.A list of issued status codes and their descriptions can be found in the Job results section, located in the AdminClient tutorial.The following job execution results are not displayed in this export:Not presentDeactivated
TimestampPreBackupLoca Timestamp of the Backup.zip file of the previous backup (in local time
TimeStampBackupUT Timestamp of the Backup.zip file of the previous backup (UTC
DirPreBacku The relative path to the directory, in the server archive, where the previous backup of the job (Backup.zip file) was stored
ErrorBackupVsPreBacku The column only contains a value if an error arose when comparing the Previous backup ↔ Backup
WarningBackupVsPreBacku The column only contains a value if an error arose when comparing Previous backup ↔ Backup
ExecutingServe The server on which the job was execute
TimestampJobStartLoca Timestamp from start of job execution (local time
TimestampJobStartUT Timestamp from start of job execution (UTC
TimestampUploadStartLoca Timestamp from start of the upload (in local time
TimestampUploadStartUT Timestamp from start of the upload (UTC
TimestampUploadEndLoca Timestamp from end of the upload (in local time
TimestampUploadEndUT Timestamp from end of the upload (UTC
TimestampCompareStartLoca Timestamp from start of the comparison (in local time
TimestampCompareStartUT Timestamp from start of the comparison (UTC
TimestampCompareEndLoca Timestamp from end of the comparison (in local time
TimestampCompareEndUT Timestamp from end of the comparison (UTC
TimestampJobEndLoca Timestamp from end of job execution (local time
TimestampJobEndUT Timestamp from end of job execution (UTC
Sourc Source of backup.The most common values are MainServer and BackupClient.
WhoToNotifyName Names of octoplant users who will be notified about job executions.Multiple names are separated by commas.This column is only displayed if sending emails about job executions is configured. For more information, see the Jobs section, located in the AdminClient tutorial.
WhoToNotifyEMail Email addresses of octoplant users who should be notified about job executions.Multiple email addresses are separated by commas.This column is only displayed if sending emails about job executions is configured. For more information, see the Jobs section, located in the AdminClient tutorial.
WhoToNotifyAdditiona Email addresses of users who do not have a octoplant account, but should still be notified about job executionsMultiple email addresses are separated by commas.This column is only displayed if sending emails about job executions is configured. For more information, see the Jobs section, located in the AdminClient tutorial.

Last update: September 15, 2023

Related Articles

IMPRINT | PRIVACY POLICY | COOKIE POLICY

Privacy Preference Center