Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

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 namefrom versionDescriptionThe type of the parameterNotes 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.
Possible values:

  • ORDINAL_NUMBER
  • IP_ADDRESS,
  • USERNAME
  • START_DATE
  • STOP_DATE
  • DURATION,
  • SUCCESS
  • NAME
  • TYPE
  • DETAILS
  • THREAD
  • USER_FIRSTNAME
  • USER_LASTNAME
  • USER_FULLNAME

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

AuditReport-2021-08-30.xlsx

Tab.1

Data compliant with PlusWorkflow 3.2.171. Additional parameters may appear in future versions of the system.

EventNameGroup
AUDIT_LOG_INLogging inAUDIT_LOGGING
AUDIT_LOG_IN_UNIVERSAL_PASSWORDLogging in by universal password
AUDIT_LOG_OUTLogging out
AUDIT_SEARCH_ACTIVITIESActivities searchingAUDIT_ACTIVITY
AUDIT_OPEN_ACTIVITYActivity open
AUDIT_SAVE_ACTIVITYActivity saving
AUDIT_ACCEPT_ACTIVITYActivity acceptance
AUDIT_ADD_COMMENT_TO_ACTIVITYActivity comment addition
AUDIT_DELETE_COMMENT_FROM_ACTIVITYActivity comment removal
AUDIT_ACTIVITY_DETAILSActivity details
AUDIT_CHECK_IN_DOCUMENT_FROM_ACTIVITYCheck in document from activity
AUDIT_SUSPEND_ACTIVITYActivity suspension
AUDIT_ABORT_ACTIVITYActivity abortion
AUDIT_ACCEPT_MANY_ACTIVITIESActivities group acceptance
AUDIT_CREATE_PROCESSProcess creationAUDIT_PROCESS
AUDIT_SEARCH_PROCESSESProcesses searching
AUDIT_UPLOAD_FILE_FROM_PROCESSFile upload from process
AUDIT_DELETE_DOCUMENT_FROM_PROCESSProcess document removal
AUDIT_PROCESS_DETAILSProcess details
AUDIT_DELETE_PROCESSProcess removal
AUDIT_DELETE_PROCESSESProcesses removal
AUDIT_ABORT_PROCESSProces abortion
AUDIT_SAVE_VIEWView save
AUDIT_RUN_VIEWView start-up
AUDIT_SEARCH_DOCCLASSDocuments searchingAUDIT_ARCHIVE
AUDIT_SEARCH_LINKLinks searching
AUDIT_UPLOAD_FILE_FROM_ARCHIVEFile upload from archive
AUDIT_CHECK_IN_DOCUMENT_FROM_ARCHIVECheck in document from archive
AUDIT_DELETE_DOCUMENT_FROM_ARCHIVEArchive document removal
AUDIT_EDIT_DOCUMENT_INDEXESDocument indexes edition
AUDIT_SEARCH_USERUser searchingAUDIT_ADMINISTRATION
AUDIT_ADD_USERUser addition
AUDIT_IMPORT_USER_FROM_LDAPUser import
AUDIT_UPDATE_USERUser update
AUDIT_DELETE_USERUser removal
AUDIT_UPDATE_USER_SETTINGS_GLOBALBulk user settings update
AUDIT_ADD_GROUPGroup addition
AUDIT_UPDATE_GROUPGroup update
AUDIT_DELETE_GROUPGroup removal
AUDIT_ADD_USER_TO_GROUPUser to group addition
AUDIT_DELETE_USER_FROM_GROUPUser from group removal
AUDIT_ADD_SYSTEM_PROTECTIONProtection addition
AUDIT_DELETE_SYSTEM_PROTECTIONProtection removal
AUDIT_ADD_DELEGATIONDelegation addition
AUDIT_DELETE_DELEGATIONDelegation removal
AUDIT_ADD_POSITIONPosition addition
AUDIT_UPDATE_POSITIONPosition update
AUDIT_DELETE_POSITIONPosition removal
AUDIT_SEARCH_POSITIONPosition searching
AUDIT_ADD_ORG_UNITOrg. unit addition
AUDIT_UPDATE_ORG_UNITOrg. unit update
AUDIT_DELETE_ORG_UNITOrg. unit removal
AUDIT_SEARCH_ORG_UNITOrg. unit searching
AUDIT_ADD_DOCCLASSDocclass addition
AUDIT_UPDATE_DOCCLASSDocclass update
AUDIT_DELETE_DOCCLASSDocclass removal
AUDIT_ADD_LINKLink addition
AUDIT_UPDATE_LINKLink update
AUDIT_DELETE_LINKLink removal
AUDIT_ADD_DIRECTORYDirectory addition
AUDIT_DELETE_DIRECTORYDirectory removal
AUDIT_ADD_DEVICEDevice addition
AUDIT_DELETE_DEVICEDevice removal
AUDIT_ADD_LDAP_SERVERLDAP server addition
AUDIT_UPDATE_LDAP_SERVERLDAP server update
AUDIT_DELETE_LDAP_SERVERLDAP server removal
AUDIT_ADD_ROLE_TO_POSITIONRole to position addition
AUDIT_DELETE_ROLE_FROM_POSITIONRole removal from position
AUDIT_ADD_NOTIFICATIONNotification addition
AUDIT_EDIT_NOTIFICATIONNotification edition
AUDIT_DELETE_NOTIFICATIONNotification removal
AUDIT_ADD_DOCUMENT_TEMPLATEDocument template addition
AUDIT_DELETE_DOCUMENT_TEMPLATEDocument template removal
AUDIT_ADD_DOC_CLASS_INDEXDocument class index addition
AUDIT_UPDATE_DOC_CLASS_INDEXDocument class index edition
AUDIT_DELETE_DOC_CLASS_INDEXDocument class index removal
AUDIT_ENABLE_USER_NOTIFICATIONSUser notifications activation
AUDIT_DISABLE_USER_NOTIFICATIONSUser notifications deactivation
AUDIT_ADD_DOC_CLASS_ACTIONDocument class action addition
AUDIT_EDIT_DOC_CLASS_ACTIONDocument class action edition
AUDIT_DELETE_DOC_CLASS_ACTIONDocument class action removal
AUDIT_ADD_PROCESS_PROTECTIONProcess protection addition
AUDIT_DELETE_PROCESS_PROTECTIONProcess protection removal
AUDIT_INSTALL_MODULEModule installation
AUDIT_UNINSTALL_MODULEModule uninstallation
AUDIT_ADD_DOCUMENT_VIEWDocument view addition
AUDIT_EDIT_DOCUMENT_VIEWDocument view edition
AUDIT_DELETE_DOCUMENT_VIEWDocument view removal
AUDIT_SAVE_PROCESS_SETTINGSProcess settings save
AUDIT_LOAD_LICENSELicense load
AUDIT_ADD_DOC_CLASS_PROTECTIONDocument class protection addition
AUDIT_EDIT_DOC_CLASS_PROTECTIONDocument class protection edition
AUDIT_DELETE_DOC_CLASS_PROTECTIONDocument class protection removal
AUDIT_ADD_LINK_INDEXLink index addition
AUDIT_EDIT_LINK_INDEXLink index edition
AUDIT_DELETE_LINK_INDEXLink index removal
AUDIT_ADD_LINK_CONNECTIONIndexes connection addition
AUDIT_DELETE_LINK_CONNECTIONIndexes connection removal
AUDIT_ADD_LINK_PROTECTIONLink protection addition
AUDIT_EDIT_LINK_PROTECTIONLink protection edition
AUDIT_DELETE_LINK_PROTECTIONLink protection removal
AUDIT_EDIT_USER_NOTIFICATIONSUser notification edition
AUDIT_DELETE_USER_NOTIFICATIONSUser notification removal
AUDIT_LOAD_PACKAGEPackage load
AUDIT_UPDATE_PACKAGEPackage update
AUDIT_CLOSE_PACKAGEPackage closing
AUDIT_CLEAR_PACKAGEUnused packages closing
AUDIT_ADD_MODULE_RIGHTModule rights addition
AUDIT_DELETE_MODULE_RIGHTModule rights removal
AUDIT_ADD_SCHEDULED_TASKScheduled task addition
AUDIT_UPDATE_SCHEDULED_TASKScheduled task edition
AUDIT_DELETE_SCHEDULED_TASKScheduled task removal
AUDIT_RUN_SCHEDULED_TASKScheduled task run
AUDIT_MANUAL_RUN_SCHEDULED_TASKManually calling of scheduled task
AUDIT_STOP_SCHEDULED_TASKScheduled task stop
AUDIT_INSTALL_PLUGIN_LICENSEPlugin license installation
AUDIT_INSTALL_PLUGINPlugin installation
AUDIT_UPDATE_PLUGINPlugin update
AUDIT_START_PLUGINPlugin start
AUDIT_STOP_PLUGINPlugin stop
AUDIT_DELETE_PLUGINPlugin removal
AUDIT_CONFIG_TRANSFER_EXPORTExport of system configuration to a file
AUDIT_CONFIG_TRANSFER_GET_FROM_BASEGetting the system configuration from the database
AUDIT_CONFIG_TRANSFER_GET_FROM_FILEGetting the system configuration from the file
AUDIT_CONFIG_TRANSFER_IMPORTImport system configuration from a file
AUDIT_SYSTEM_PARAMETER_CREATEDAdding a new system parameter.
AUDIT_SYSTEM_PARAMETER_REMOVEDRemoving a system parameter.
AUDIT_SYSTEM_PARAMETER_CHANGEDChanging a system parameter.
AUDIT_PASSWORD_PROFILE_CREATEDAdding new password policy profile
AUDIT_PASSWORD_PROFILE_CHANGEDChanging password policy profile
AUDIT_PASSWORD_PROFILE_REMOVEDRemoving password policy profile
AUDIT_PASSWORD_PROFILE_PRIORITY_CHANGEDChanging priorities of password policy profiles
AUDIT_PASSWORD_PROFILES_ASSIGNEDAssigning password policy profiles
AUDIT_CERTIFICATES_ADDEDCertificates imported
AUDIT_CERTIFICATES_RENAMEDCertificate alias changed
AUDIT_CERTIFICATES_REMOVEDCertificate removed
AUDIT_DEACTIVATE_USERUser deactivation
AUDIT_ACTIVATE_USERUser activation
AUDIT_EDIT_DEACTIVATED_USERDeactivated user edit
AUDIT_IMPORT_USERS_FROM_GROUP_TO_GROUPImporting users from group to group
AUDIT_BLOCK_USER_BY_ADMINBlocking user by administrator
AUDIT_UNLOCK_USER_BY_ADMINUnlocking user by administrator
AUDIT_ASSIGN_POSITION_TO_USERAssigning position to user
AUDIT_DETACH_POSITIONDetaching position from user
AUDIT_ADMIN_ADD_DOC_CLASS_ASSOCIATIONAdd association between document classes
AUDIT_ADMIN_DELETE_DOC_CLASS_ASSOCIATIONDelete a association between document classes
AUDIT_ADMIN_UPDATE_DOC_CLASS_ASSOCIATIONModify a association between document classes
AUDIT_STATSStatisticsAUDIT_USER
AUDIT_UPDATE_USER_SETTINGSUser settings update
AUDIT_CHANGE_PASSWORDPassword change
AUDIT_ADD_VIEW_REPORTView report additionAUDIT_REPORTS
AUDIT_ADD_SQL_QUERY_REPORTQuery report addition
AUDIT_ADD_JASPER_REPORTJasper report addition
AUDIT_EDIT_JASPER_REPORTJasper report edition
AUDIT_RUN_VIEW_REPORTView report run
AUDIT_RUN_SQL_QUERY_REPORTQuery report run
AUDIT_RUN_JASPER_REPORTJasper report run
AUDIT_RUN_SAVED_REPORTSaved report run
AUDIT_FILTER_REPORTReport filtering

 

 

Tab.2

Columns used when generating a report in an MS Excel file

 

Column typeNameValue example

ORDINAL_NUMBER

Ordinal number5
IP_ADDRESSIP address0:0:0:0:0:0:0:1

USERNAME

Usersadmin

START_DATE

Start time2021-08-26 15:17:59

STOP_DATE

Stop time2021-08-26 15:18:01
DURATIONDuration1.458

SUCCESS

Successtrue

NAME

NameScheduled task addition

TYPE

TypeAUDIT_ADD_SCHEDULED_TASK

THREAD

Thread idhttp-nio-8080-exec-6

USER_FIRSTNAME

First nameAdministrator

USER_LASTNAME

Last namePlusWorkflow

USER_FULLNAME

First and last nameAdministrator PlusWorkflow

DETAILS

Audit detailsClass 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

  • No labels