Differences

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

--- reports:audit_report [2026/07/01 15:49] – Created Audit Report documentation 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 API returns the report in JSON format.
+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''.
+In this form, the request always retrieves data for the entire organization, but it is also possible to filter the report for specific users.
+This method returns a JSON document with the following structure:
 {{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 93: / Line 98: @@
 Available filters:
-  * Duration
+  * **Duration** – Select the reporting period (current day/week/month, previous complete day/week/month, last X days/weeks/months or a custom date range).
-  * User
+  * **User** – Select users from the company structure or enter them manually.
-  * User Role
+  * **User Role** – Alternatively, users can be selected based on their assigned roles.
 This method downloads the report in XLSX format.
@@ Line 105: / 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:
-Configuration parameters:
+https://jobctrl.com/install/external/CustomReportDownloaderTool/CustomReportDownloaderTool_v1.1.9_req_v377.zip
-  * Auth code
+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.
-  * JC API Address
-  * JC REST API Address
+It can be configured by running ''CustomReportDownloaderTool.exe'':
-  * Service name
 {{reports:audit_report_04.png|Report Downloader configuration}}
-Additional configuration options:
+  * **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.
-  * Job name
+Click ''Save'', then click ''Install service''.
-  * Output path
-  * Sheet name
-  * User IDs
-  * User Group IDs
-  * Report interval
 {{reports:audit_report_05.png|Report Downloader settings}}
-After configuration click ''Save'' and then ''Restart service''. The report will automatically be downloaded according to the configured schedule.
+  * **Job name** – Any name can be specified.
+  * **Output path** – The location where the downloaded report will be saved.
+  * **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.
+  * **Sheet name** – Enter the worksheet to be downloaded.
+  * **Report interval** – Defines how often the report is downloaded automatically.
+  * **Start day / End day** – Specifies the reporting period.
+  * **User IDs** – Users to be included in the report. If left empty, the report is generated for the entire company.
+  * **User Group IDs** – User groups to be included in the report. If left empty, the report is generated for the entire company.
+  * **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.
+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.
 ===== Audit Report as a security alert =====