KB-127661: Exporting the job list

Exporting the job list

The JobList export type creates a summary of the jobs and their results.

The export can be produced either as 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 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 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 to a component (with its name).

Note

This key is ignored if a value is specified for ComponentID.

IncludeAllComponents

Determines whether components are listed, for which no jobs have been configured. This makes it possible, for example, to see at a glance whether two jobs have been set up for all Sinumerik components.

The following values are possible:

  • Y: Components without jobs are listed
  • N: Components without jobs are not listed (default value)

Example call:

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

Parameter file CiCoLog.ini

[Common]
ReportType=JobList
ExportFile=D:TestmyJobList.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 Upload type of the jo
WhoToNotif List of users to be notified about the job executio
WhoToNotifyName Names of octoplant users to be notified about job executionsMultiple names are separated by commas.This column is only displayed when sending emails about job executions is configured.
WhoToNotifyEMail Email addresses of octoplant users who should be notified about job executionsMultiple email addresses are separated by commas.This column is only displayed if sending emails about job executions is configured.
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 when sending emails about job executions is configured.
Executio Execution status of the jobThe following values are possible:0: Not according to a schedule1: According to a schedule2: Using the BackupClient
IpOrComputernam IP address or computer nameThe value is issued dependent on the upload class
UploadAgen Computer name or IP address of agentThis value is only issued when an upload agent is assigned to the job.
CompareAgen Computer name or IP address of agentThis value is only issued when an upload agent is assigned to the job.
LastCheck (local Date of last scheduled job execution (local time
LastCheck (UTC Date of last scheduled job execution (UTC
NextStart (local Starting time of next scheduled job execution (local time
NextStart (UTC Starting time of next scheduled job execution (UTC
JobStart (local Actual start time of the last job execution (manual or scheduled) (local time
JobStart (UTC Actual start time of the last job execution (manual or scheduled) (UTC
JobFinish (local End time of the last job execution (manual or scheduled) (local time)
JobFinish (UTC End date of the last job execution (manual or planned) (UTC
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 AdminClienttutorial.
ErrorVersionVsBacku The column only contains a value if an error has occurred when comparing Server version ↔ Backup
WarningVersionVsBacku The column only contains a value if an error has 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 AdminClienttutorial.
WarningBackupVsPreBacku The column only contains a value if an error arose when comparing Previous backup ↔ Backup
ErrorBackupVsPreBacku The column only contains a value if an error arose when comparing the Previous backup ↔ Backup
DirBacku The relative path of the directory in the server archive where the current backup of the job (Backup.zip file) was stored.
TimeStampBackup (local Timestamp of the Backup.zip file (local time
TimeStampBackup (UTC Timestamp of the Backup.zip file (UTC)
DirPreBacku The relative path to the directory, in the server archive, where the previous backup of the job (Backup.zip file) was stored
TimeStampBackup (local Timestamp of the Backup.zip file of the previous backup (in local time)
TimeStampPreBackup (UTC Timestamp of the Backup.zip file of the previous backup (UTC)
OutOfDate Shows whether the period (since the last backup) is longer than the set value.The following values are possible:Y: The backup is out of date.N: The backup is not out of date.?: The job has never been executed or no backup was yet created.
VersionVsBackupVersionNumber Version number of the data that was used for the version and backup comparison.
DeactivatedComment Text entered when a job was deactivated.

Last update: September 15, 2023

Related Articles

IMPRINT | PRIVACY POLICY | COOKIE POLICY

Privacy Preference Center