Jobs

Overview

The Jobs Page is a centralized hub for managing and tracking tasks related to report generation and data export. It allows users to monitor job statuses, view job details, and download output files. This feature is particularly valuable for IT and security engineers who need insights or structured data for analysis, sharing, or compliance purposes. By streamlining the management of reporting and export jobs, the Jobs Page enhances operational efficiency and data accessibility.

Layout

The Jobs Page features a table with the following key columns:

• Job Title: Displays the name of the analyzer or table widget associated with the job.

• Status: Indicates the current status of the job (e.g., In Progress, Completed, Failed).

• Date: Shows the date when the job was initiated.

• Type: Specifies the type of job (ReportJobType or ExportJobType).

• User: Identifies the user who initiated the job.

• Action: Provides a direct link to download the file generated by the job.

Job Types

Report Job (ReportJobType)

• Generates an HTML file containing detailed information about an analyzer.

• Ideal for reviewing or sharing analyzer details in a structured report format.

• Commonly used by users needing comprehensive insights into analyzer configurations or results.

Export Job (ExportJobType)

• Produces a CSV file containing the data from a table-type widget.

• Useful for extracting structured data for external analysis, reporting, or integration with other tools.

Interaction and Navigation

Viewing Job Details

• Navigate to the Jobs Page to view a list of all jobs in the table.

• Details such as job title, status, date, type, and user are displayed for each entry.

Sorting and Filtering

• Use the table's sort and filter options to organize jobs by attributes such as:

  • Date

  • Status (e.g., Completed, Failed)

  • Job Type (e.g., ReportJobType, ExportJobType)

Accessing Download Links

• Locate the Action column for the desired job.

• Click the provided link to download the output file (HTML for Report Jobs or CSV for Export Jobs).

Practical Examples

Example 1: Generating a Report Job

• Select an analyzer that you want to generate a report for.

• Initiate a Generate Report to create the HTML report.

• Once the job is completed, navigate to the Jobs page.

• Locate the job entry and check its status (e.g., Completed).

• Click on the Download Link to download the HTML file containing the full report.

Analyzer for report generation:

HTML file data:

Entry in the Jobs table:

Example 2: Exporting Data

• Choose a table widget whose data you want to export.

• Start an Export as CSV to generate a CSV file.

• When the job completes, find the job in the Jobs page.

• Check the job status to ensure it’s Completed.

• Click on the Download Link to retrieve the CSV file with the table's data.

Widget to be exported:

CSV file data:

Entry in the Jobs table:

Example 3: Tracking Job Status

• In the Jobs Table, filter jobs by status (e.g., Completed).

• Quickly locate the finished jobs and download their corresponding files.

• Monitor the status of ongoing jobs to determine when they will be available for download.

Notes and Best Practices

• File Size: Large jobs may take additional time to process. Monitor their status periodically.

• Supported Formats: Ensure the requested output format (HTML or CSV) aligns with your data requirements.

• Tips:

  • Use filters to narrow down specific jobs.

  • Regularly review completed jobs to avoid redundancy.

  • Address failed jobs promptly to ensure data availability.

Accessibility and Support

If you encounter any issues or need further assistance:

• Consult the Kaleidoscope's help section.

• Contact support for troubleshooting or additional guidance.