← Back to plugin index

User Trail Log Import Task

Description

Task to import user trail log files into the user trail log database.

This task is typically used once in a migration scenario where logs from existing user trail log files should be imported into the database. This task also imports logs from files in subdirectories.

Note:

  • This task should only be run on demand and should not be scheduled on a regular basis. Logs will be imported multiple times if the task is run multiple times for the same files.

  • A log file is always either imported completely or not at all. If an error occurs while importing a log file, the task is stopped, no logs are imported from this file and the source file remains unchanged.

  • This task works on parsable user trail log files only. The default naming of these files is "medusa-usertrail.log".

Type name
UserTrailLogImportTask
Class
com.airlock.iam.servicecontainer.app.application.configuration.task.usertrail.UserTrailLogImportTaskConfig
May be used by
Properties
Database Repository (databaseRepository)
Description
Defines the user trail log database into which file based logs are to be imported.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Import Directory (importDirectory)
Description

The directory from which user trail log files will be imported. All filenames matching the filter pattern are used.

If a relative path is specified, the task will look for directories within your config folder. Note that this task will search all nested subdirectories.

Attributes
File/Path
Mandatory
Filename Filter (filenameFilter)
Description

Import filename regular expression pattern.

Only filenames completely matching this regular expression are imported.

Attributes
RegEx
Optional
Default value
medusa-usertrail\.log(\.\d+)?
Delete Files After Import (deleteFilesAfterImport)
Description
If enabled, successfully imported user trail log files within the specified directory are deleted.
Attributes
Boolean
Optional
Default value
false
YAML Template (with default values)

type: UserTrailLogImportTask
id: UserTrailLogImportTask-xxxxxx
displayName: 
comment: 
properties:
  databaseRepository:
  deleteFilesAfterImport: false
  filenameFilter: medusa-usertrail\.log(\.\d+)?
  importDirectory: