Differences

This shows you the differences between two versions of the page.

--- reports:audit_report [2026/07/01 16:29] – support
+++ reports:audit_report [2026/07/01 17:30] (current) – support
@@ Line 69: / Line 69: @@
 ==== Via REST API ====
-The Audit Report can be retrieved using the following REST API function:
+The Audit Report is available with the following function:
-https://jobctrl.com/api/restapi/GetCustomReport
+https://jobctrl.com/api/restapi/GetCustomReport?companyAuthCode=XXXXXXXX&definitionId=YYYY&utcStartDate=2022-10-14&utcEndDate=2022-10-15&minimalTimeForIdleStatusInSec=120
-The REST API supports the following parameters:
+The function contains a ''companyAuthCode=XXXXXXXX'' section, where the company's authentication code must be inserted instead of ''XXXXXXXX'' (the registrant administrator can find this code on the Company Data page), and in the ''definitionId=YYYY'' section, the report identifier must be substituted instead of ''YYYY''.
-  * **companyAuthCode** – Company authentication code. The company administrator can find this value in the Company Data page.
+In this form, the request always retrieves data for the entire organization, but it is also possible to filter the report for specific users.
-  * **definitionId** – Identifier of the report to be retrieved.
-  * **utcStartDate** – Start date of the requested reporting period (UTC).
-  * **utcEndDate** – End date of the requested reporting period (UTC).
-  * **minimalTimeForIdleStatusInSec** – Minimum idle time (in seconds) used during report generation.
-The API request retrieves data for the entire company by default. It is also possible to filter the report for specific users.
+This method returns a JSON document with the following structure:
-The API returns the report in JSON format.
 {{reports:audit_report_01.png|Audit Report JSON structure}}
-The JSON contains the following elements:
+All tables contain the following elements:
-  * Columns – names of the columns in the worksheet.
+  * '''Columns''' – The names of the columns in the table.
-  * Rows – row data.
+  * '''Rows''' – The data arranged in rows according to the order of the columns.
-  * TableName – worksheet name.
+  * '''TableName''' – Name of the worksheet.
+The ''Hide'' and ''Delete'' switches are only used during XLS report generation and have no effect on the JSON output.
-The ''Hide'' and ''Delete'' switches are only used during XLS generation and have no effect on JSON export.
 ==== Via WEB ====
@@ Line 115: / Line 110: @@
 ==== Via Report Downloader Tool ====
-The Report Downloader Tool allows automatic downloading of the Audit Report in CSV format.
+The report download service can be downloaded via the following link:
-The download package is available from:
+https://jobctrl.com/install/external/CustomReportDownloaderTool/CustomReportDownloaderTool_v1.1.9_req_v377.zip
-https://jobctrl.com/install/external/CustomReportDownloaderTool/
+The downloaded file must be unpacked into a suitable directory, and it is important that the installation of the application must be run as administrator.
-After downloading:
+It can be configured by running ''CustomReportDownloaderTool.exe'':
-  * Extract the ZIP archive.
+{{reports:audit_report_04.png|Report Downloader configuration}}
-  * Run the installer with administrator privileges.
-  * Start the ''CustomReportDownloaderTool.exe'' application.
-Configuration parameters:
+  * **Auth code** – The authentication code mentioned during the API download must be entered here.
+  * **JC API Address** – https://jobctrl.com/api/api.asmx (for companies hosted in the cloud).
+  * **JC REST API Address** – https://jobctrl.com/api/restapi/ (for companies hosted in the cloud).
+  * **Service name** – CustomReportDownloaderService.
-  * **Auth code** – Company authentication code.
+Click ''Save'', then click ''Install service''.
-  * **JC API Address** – API endpoint of the JC360 server.
-  * **JC REST API Address** – REST API endpoint of the JC360 server.
-  * **Service name** – Windows service name used by the downloader.
-{{reports:audit_report_04.png|Report Downloader configuration}}
+{{reports:audit_report_05.png|Report Downloader settings}}
-Additional configuration options:
+  * **Job name** – Any name can be specified.
+  * **Output path** – The location where the downloaded report will be saved.
-  * **Job name** – Name of the scheduled download job.
+  * **Use only suffix / Use fixed name** – When ''Use only suffix'' is selected, every download is saved as a new file. When ''Use fixed name'' is selected, the existing file is overwritten on every download.
-  * **Output path** – Destination folder of downloaded reports.
+  * **Sheet name** – Enter the worksheet to be downloaded.
-  * **Use only suffix / Use fixed name** – Controls whether a new file is created for every download or an existing file is overwritten.
+  * **Report interval** – Defines how often the report is downloaded automatically.
-  * **Sheet name** – Worksheet to download.
+  * **Start day / End day** – Specifies the reporting period.
-  * **Report interval** – Frequency of automatic downloads.
+  * **User IDs** – Users to be included in the report. If left empty, the report is generated for the entire company.
-  * **Start day / End day** – Reporting period.
+  * **User Group IDs** – User groups to be included in the report. If left empty, the report is generated for the entire company.
-  * **User IDs** – Users included in the report.
-  * **User Group IDs** – User groups included in the report.
   * **Max affected users per request** – Maximum number of users processed in a single request.
   * **Minimal time for idle status (sec)** – Idle time threshold used during report generation.
-{{reports:audit_report_05.png|Report Downloader settings}}
+After configuration, click ''Save'' and then ''Restart service''. The tool downloads the report according to the configured settings and saves it as a CSV file in the specified output path.
-After configuration click ''Save'' and then ''Restart service''. The downloader service will automatically retrieve the report according to the configured schedule and save it as a CSV file in the specified output folder.
 ===== Audit Report as a security alert =====