Basic information
Package: com.suncode.plugin.scheduldedtask.task
Category:
Available from version: 1.0.X
Description
The task downloads audits from the last days, generates a file in MS Excel format and sends it by e-mail to the indicated recipients. The report is generated in the default language set in the system parameters. Name of the file "AuditReport- <launch date> .xlsx" example: AuditReport-2021-08-24.xlsx. You can send one email to all recipients, or each recipient will receive a copy of the email
Configuration parameters
Id of the variables from the process
| Parameter name | from version | Description | The type of the parameter | Notes and Restrictions |
|---|---|---|---|---|
Recipient type* | 1.0.X | Possible types: EMAIL, USER | String | EMAIL - "Message recipients" parameter accepts e-mail addresses. USER - "Message recipients" parameter accepts logins of users for whom the e-mail address will be downloaded. |
Recipients of the message* | 1.0.X | List of recipients of messages with a decimal point | String | The value depends on the value of the "Recipient type" parameter |
Message Subject* | 1.0.X | The subject of the e-mail | String |
|
Message template* | 1.0.X | The path on the server to the file containing the message body | String | Path to the text file on the server. Recommended format: HTML |
Group messages* | 1.0.X | true - sends one message to everyone, false - each recipient gets a copy of the message. | Boolean |
|
Event name - GROUP | 1.0.X | The group / category of events that will be included in the report. Possible values AUDIT_LOGGING, AUDIT_ACTIVITY, AUDIT_PROCESS, AUDIT_ARCHIVE, AUDIT_ADMINISTRATION, AUDIT_USER, AUDIT_REPORTS | String | Possible values: AUDIT_LOGGING, AUDIT_ACTIVITY, AUDIT_PROCESS, AUDIT_ARCHIVE, AUDIT_ADMINISTRATION, AUDIT_USER, AUDIT_REPORTS |
The name of the event | 1.0.X | Name of the event that will be included in the generated report. Successive events may be listed after a decimal point. | String | Possible values are listed in Tab.1 below |
Columns in the report* | 1.0.X | Selected columns that will be generated in the file. Possible columns: ORDINAL_NUMBER, IP_ADDRESS, USERNAME, USER_FIRSTNAME, USER_LASTNAME, USER_FULLNAME, START_DATE, STOP_DATE, DURATION, SUCCESS, NAME, TYPE, DETAILS, THREAD. | String | The order of the given columns is important.
Detailed description in Tab.2 below |
Number of days* | 1.0.X | The number of last days for which the report is to be generated. | Integer | It is counted from the scheduled task execution date. |
Sample configuration
An example of a generated report
Tab.2
Columns used when generating a report in an MS Excel file
| Column type | Name | Value example |
|---|---|---|
ORDINAL_NUMBER | Ordinal number | 5 |
| IP_ADDRESS | IP address | 0:0:0:0:0:0:0:1 |
USERNAME | Users | admin |
START_DATE | Start time | 2021-08-26 15:17:59 |
STOP_DATE | Stop time | 2021-08-26 15:18:01 |
| DURATION | Duration | 1.458 |
SUCCESS | Success | true |
NAME | Name | Scheduled task addition |
TYPE | Type | AUDIT_ADD_SCHEDULED_TASK |
THREAD | Thread id | http-nio-8080-exec-6 |
USER_FIRSTNAME | First name | Administrator |
USER_LASTNAME | Last name | PlusWorkflow |
USER_FULLNAME | First and last name | Administrator PlusWorkflow |
DETAILS | Audit details | Class name: com.suncode.plugin.scheduldedtask.task.AuditReportTask Scheduled task name: Sending an audit report Scheduled task description: The task generates an audit report in MS Excel format and sends it by e-mail. Category: PLUS_SCHEDULED_TASK First run date: 2021-08-30 13:27:25 Period of repetition: 1 Minutes Active: No Save execution history: Yes |
Change log
1.0.X (applicable documentation)
- Create a scheduled task