How Can We Help?

Installation

Process Intelligence Kit (PI Kit) serves for ETL process (Extraction, Transformation, and Load) from M-Files to a specific database. There are three options: Data Export, Audit Log Export, and Logging. Data Export serves for exporting M-Files log data to a database, Audit Log Export serves for exporting M-Files audit to a database, and Logging serves for sending M-Files logs.

Configuration

Data Export

  • Export vault data to a database
    • Object changes, state and assignment changes
  1. Configure database connection
    – Create an empty database in SQL Server
  2. Configure PI Kit
  3. Execute the Setup database command to generate required SQL objects
  4. When the database has been set up, data can be exported in two ways:
    Manually, by pulling it from the vault – reconstructing events from object histories
    On a schedule, by reading events from M-Files Log
  5. The recommended approach is first to pull from the vault manually, and then configure periodic export from M-Files Event Log

Buttons:

  • Stop running task -> Stopping task to run while it is in progress
  • Cancel pending tasks -> Canceling tasks that were meant to be executed afterward
  • Setup database -> Connecting to a configured database
  • Pull data – Generating data
  • Update data

Audit Log Export

  • Periodical audit event export in a database
  • Export audit log data to a database
    • Login, logout
  1. Configure database connection
    – Create an empty database in SQL Server
  2. Configure PI Kit
  3. Execute the Setup database command to generate required SQL objects
  4. When the database has been set up, data can be exported in two ways:
    – Manually, by pulling it from the vault – reconstructing events from object histories
    – On a schedule, by reading events from M-Files Log
    The recommended approach is first to pull from the vault manually, and then configure periodic export from M-Files Event Log
  5. When the database has been set up, configure periodic export of audit events from M-Files Event Log

Button:

  • Cancel pending tasks
  • Setup database

Configuring PI Kit

Data Export

FieldValueDescription
EnabledYes / NoWhether the operation is enabled or not
Export destinationExport destination database
Database typeSQL ServerA type of database for export
Database type -> Connection stringDatabase connection string
ValueExample: Data Source=[SERVER_NAME];Initial Catalog=[DATABASE_NAME];Persist Security Info=True;User ID=[USER];Password=[PASS]
Use the secure passwordYes / NoSet password to use in the connection string. Any password value specified in the connection string above will be overridden with a value specified in the secured Password field.
PasswordPassword to use in the connection string.
Export frequencyFrequency for exporting events from M-Files Event Log
TypeUnknown, Interval, Schedule
Type -> Configuration (Interval)When Type = Interval
Configuration -> IntervalChoose interval, numeric-
Configuration -> Run on vault startYes / NoIf true, runs when the vault starts. If false, the first run is scheduled to be after the interval has elapsed.
Type -> ScheduleWhen Type = Schedule
Configuration -> EnabledYes / NoWhether the configuration is enabled or not
Configuration -> TriggersUnknown / Daily / Weekly / Monthly
Configuration -> Triggers -> DailyTime
Configuration -> Triggers -> Weekly -> Trigger DaysAdd DayOfWeek
Configuration -> Triggers -> Weekly -> Trigger TimesAdd time
Configuration -> Triggers -> Weekly -> Unrepresentable Date HandlingHow to handle dates that cannot be represented – e.g. 29 February
Configuration -> Triggers -> Weekly -> Trigger DaysAdd number
Configuration -> Triggers -> Weekly -> Trigger TimesAdd time
Configuration ->Run on vault startYes / No
Included object typesAll / SelectedThis setting controls whether all events will be exported, or only those that occurred on selected object types
Object types filterObject type(if Included object types = Selected) – only those events that occurred on objects of selected types will be exported
Ignored login accountsLogin accountEvents caused by login accounts specified here will be ignored
Data enrichment rulesThese rules are used for the enrichment of exported data. You can define multiple rules to configure which metadata properties will be exported for any given object.
Rule group -> NameGroup name.
Rule group -> RulesRules are used for the enrichment of exported data. You can define multiple rules to configure which metadata properties will be exported for any given object.
Rule -> NameRule name.
Rule -> DescriptionRule description.
Rule -> EnabledSpecifies whether a rule is in use.
Rule -> Filter conditionsFilter conditions define objects that this rule applies to. Multiple conditions inside a filter are combined with AND operator, while multiple filters are combined with the OR operator.
Filter conditions -> Seach conditions
Rule -> Simple propertiesAdditional simple properties that will be included in data export.
Simple property -> Property
Rule -> Custom propertiesAdditional custom properties that will be included in data export.
Custom property -> Column nameDatabase column name.
Custom property -> TypeExpression / TimelineIdType of custom property.
Custom property -> Data typeUninitialized, text, integer, floating, date, time, timestamp, boolean, lookup, multi-select lookup, integer64, file time, multi-line text, ACLExpression result data type.
Data pull settingsSettings for pulling data from the vault
Events insert health checkFrequency of periodic check if any unprocessed events exist in the database. If such events exist, the operation will be resumed.
Events insert health check -> TypeUnknown / Interval / Schedule
Configuration (Interval) -> EnabledYes / No
Configuration -> Triggers -> Trigger
Trigger -> TypeUnknown / Daily / Weekly / Monthly
Type -> Configuration (Daily) -> Trigger TimesTime
Type -> Configuration (Weekly) -> Trigger DaysAdd DayOfWeek -> Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
Type -> Configuration (Weekly) -> Trigger TimeTime
Type -> Configuration (Monthly) -> Configuration -> Unrepresentable Date HandlingHow to handle dates that cannot be represented (e.g. 29 February)
Type -> Configuration (Monthly) -> Trigger DaysAdd DayOfWeek -> Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
Type -> Configuration (Monthly) -> Trigger TimeTime
Events insert health check -> Run on vault startYes / NoIf true, runs when the vault starts. If false, the first run is calculated from the triggers.
Start date (inclusive)
Start time (inclusive)
End date (inclusive)
End time (inclusive)

Audit Log Export

FieldValueDescription
EnabledYes / NoWhether the operation is enabled or not
Export destinationExport destination database
Database typeType of database for export.
Connection string -> ValueDatabase connection string.
Example: Data Source=[SERVER_NAME];Initial Catalog=[DATABASE_NAME];Persist Security Info=True;User ID=[USER];Password=[PASS]
Connection string -> Use secure passwordSet password to use in the connection string. Any password value specified in the connection string above will be overridden with a value specified in the secured Password field.
PasswordPassword to use in the connection string.
Export frequencyUnknown / Interval / Schedule
Type (Interval) -> Configuration -> Interval
Type (Interval) -> Configuration -> Run on vault startYes / NoIf true, runs when the vault starts. If false, the first run is scheduled to be after the interval has elapsed.
Type (Schedule) -> Configuration -> EnabledYes / No
Type (Schedule) -> Configuration -> Triggers -> Trigger -> TypeUnknown / Daily / Weekly / Monthly
Trigger -> Type (Daily) -> Configuration -> Trigger TimesAdd time
Trigger -> Type (Weekly) -> Configuration -> Trigger DaysAdd DayOfWeek
Trigger -> Type (Weekly) -> Configuration -> Trigger TimesAdd time
Trigger -> Type (Monthly) -> Configuration -> Unrepresentable Date HandlingHow to handle dates that cannot be represented (e.g. 29 February)
Trigger -> Type (Monthly) -> Configuration -> Trigger DaysAdd number
Trigger -> Type (Monthly) -> Configuration -> Trigger TimesAdd time
Ignored login accountsEvents caused by specified login accounts specified will be ignored.
Logging account

Logging

FieldValueDescription
EnabledYes / NoWhether the operation is enabled or not
Minimum log levelVerbose, debug, information, warning, error, fatalMinimum log event level for sending events to file and event log.
Logging destinationsLogging destinations. Application restart is required for changes to this setting to take effect.
File -> EnabledYes / NoSpecifies whether logs are sent to a specified destination.
File -> FolderThe folder where log files will be generated. Requires vault restart for changes to take effect.
File -> Logs file size limit (MB)The approximate maximum size, in bytes, to which a single log file will be allowed to grow. When the file size limit is reached, a new file will be created. Filenames will have a number appended in the format <code>_NNN</code>, with the first filename given no number. Requires vault restart for changes to take effect.
File -> Retention policyRetention policy for log files. Requires vault restart for changes to take effect.
Retention policy -> Verbose logs retentionThe number of verbose log files to retain. Set to 0 to retain all files.
Retention policy -> Debug logs retentionThe number of debug log files to retain. Set to 0 to retain all files.
Retention policy -> Information logs retentionThe number of information log files to retain. Set to 0 to retain all files.
Retention policy -> Error logs retentionThe number of error log files to retain. Set to 0 to retain all files.
Event log -> EnabledYes / NoSpecifies whether logs are sent to Windows event log.
External dashboard -> EnabledYes / NoSpecifies whether application logs are sent to the dashboard.

Use case

Event logs export for process mining

In order to analyze a specific M-Files workflow, first we need to find and export event logs that relate to that specific process. To do event logs extraction from M-Files, the PI Kit will be used with its Data Export feature.

First, we need to have a prepared SQL Server database in which the PI Kit will store data. After that, we go back to M-Files Admin → Configurations → Process Intelligence Kit where we start with the configuration.

For this case, we are using the Data Export feature. First thing is to enable configuration to be executed later, after which we choose the export destination by creating a connection string with a database that we earlier created.

Next is to choose an export frequency, however, this can be left empty.

After that, we have to choose whether all object types will be included, or only specific ones. If we choose Selected the next property Object types filter will ask us to select ones to be included in the data export.

Next is Ignored logic accounts which will be left empty since we need all accounts to be included in the export.

After that comes the most important property if we want to add specific data to our event logs → Data enrichment rules. Here we define specific rules for filtering M-Files properties or adding additional properties to our event logs. This could be location, users, etc.

Lastly, the data pull setting allows for specifying when will data export be executed due to specific database constraints.

Table of Contents
FREE WEBINAR

Unlock the full potential of M-Files

No coding, faster configuration and better quality for your clients. See Extension Kit in action!