Exporting the job list
The job list export contains an overview of the jobs and their results.
In addition to selecting the export format and specifying the CSV separator, you can configure other export options, such as:
- Whether to export the entire Project tree, a specific object, or an individual component.
- Whether to include components that have no jobs configured. This allows you to quickly identify, for example, whether all Sinumerik components have two jobs assigned.
Settings for the ExportModule
In addition to the keys described under Parameter file, the parameter file can also contain the following keys specifically for this export.
| Key | Description | Values |
|---|---|---|
| Dir | Relative path of the part of the Project tree to be exported. Info: This key is ignored if a value is specified for ComponentID. | - No value: the entire Project tree is exported, with the exception of the directories and components to which the executing user has no access (default value) - Entry preceded by a backslash ("\"). The path of a component (with name) can also be entered. |
| IncludeAllComponents | Specifies whether components are listed for which no jobs have been configured. This makes it possible to see at a glance, for example, whether two Jobs have been set up for all Sinumerik components. | Y: Components without jobs are listed. N: Components without jobs are not listed (default value) |
Example call
Parameter file exportJobList.ini
[Common]
ReportType=JobList
ExportFile=D:\Test\myJobList.csv
Dir=\SmartShopFloor
[User]
Account={User}
Password={Password}
Output file
The export can be generated in either CSV or JSON format, depending on your selected output option.
The CSV output file contains the following columns.
| Column | Description |
|---|---|
| Component | Name of the component (with its path in the Project tree) |
| ComponentID | ID of the component (in GUID format) |
| ComponentTypeID | ID of the component type (in GUID format) |
| ComponentTypeName | Name of the component type |
| JobID | ID of the job (in GUID format) |
| JobName | Name of the job |
| UploadClass | Upload type of the job |
| WhoToNotify | List of users to be notified about job execution |
| WhoToNotifyNames | Names of the users who are to be notified of job executions. Multiple names are separated by commas. This column is only displayed if the sending of e-mails for job executions is configured. |
| WhoToNotifyEMails | Email addresses of the users who are to be notified about job executions. Multiple email addresses are separated by commas. This column is only displayed if the sending of emails for job executions is configured. |
| WhoToNotifyAdditional | Email addresses of users who do not have a versiondog account but should still be notified about job executions. Multiple email addresses are separated by commas. This column is only displayed if the sending of emails for job executions is configured. |
| Execution | Execution status of the job. Values: 0: Not according to schedule. 1: By schedule. 2: By BackupClient |
| IpOrComputername | IP address or computer name The value is output depending on the upload class. |
| UploadAgent | Computer name or IP address of the agent The value is only output if an Upload agent is assigned to this job. |
| CompareAgent | Computer name or IP address of the agent The value is only output if a Compare agent is assigned to this job. |
| LastCheck (local) | Time of the last scheduled job execution (local time) |
| LastCheck (UTC) | Time of the last scheduled job execution (UTC) |
| NextStart (local) | Start time of the 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 time of the last job execution (manual or planned) (UTC) |
| ResultVersionVsBackup | Result of the comparison between the version on the server and the backup Status code issued and their descriptions are listed under Job results. |
| ErrorVersionVsBackup | The column only contains a value if an error occurred during the Server version ↔ Backup comparison. |
| WarningVersionVsBackup | The column only contains a value if a warning was issued during the Server version ↔ Backup comparison. |
| ResultBackupVsPreBackup | Result of the comparison between the current and the previous backup Status code issued and their descriptions are listed under Job results. |
| WarningBackupVsPreBackup | The column only contains a value if a warning was issued during the Previous backup ↔ Backup comparison. |
| ErrorBackupVsPreBackup | The column only contains a value if an error occurred during the Previous backup ↔ Backup comparison. |
| DirBackup | Relative path of the directory in the server archive in which the current backup of the job (Backup.zip file) was saved |
| TimestampBackup (local) | Timestamp of the Backup.zip file (local time) |
| TimestampBackup (UTC) | Timestamp of the Backup.zip file (UTC)N: The backup is not out of date. ?: The job has never been executed or no backup has been created yet. |
| DirPreBackup | The relative path to the directory, in the server archive, where the previous backup of the job (Backup.zip file) was stored |
| TimestampPreBackup (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. Values: 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 used for the version and backup comparison |
| DeactivatedComment | Text entered when a job was deactivated |
Related topics