README

The laravel-eventlog package is designed to facilitate the extraction of process mining event log data within Laravel applications. If you’re working on a Laravel project that involves any central activity table this package might be helpful. Whether you’re using popular packages like spatie/laravel-activitylog or snipe/snipe-it, laravel-eventlog has you covered.

Process mining is a data-driven discipline that aims to extract valuable insights from event logs generated by information systems. These event logs capture the execution of processes within an organization, providing a wealth of information about how activities are performed, their sequences, and potential bottlenecks. Here’s where OCEL (Object-Centric Event Log) comes into play: OCELs serve as the foundation for object-centric process mining (OCPM). Unlike traditional event logs, which focus on process instances (cases) and their associated activities, OCELs take a different perspective. In OCELs, each event is related to specific objects (e.g., orders, customers, products) rather than just process instances. These objects can be uniquely identified instances (e.g., “order-123”) and have associated attributes that may change over time. OCELs allow us to capture more detailed information about objects and their relationships.

Implemented Export Formats

Implements OCEL 1.0 as xml export

Support us

Installation

You can install the package via composer:

composer require dtdi/laravel-eventlog

You should publish the config file with:

php artisan vendor:publish --tag="laravel-eventlog-config"

This is the contents of the published config file:

return [

    /*
     * This model will be used as base event.
     * and extend Illuminate\Database\Eloquent\Model.
     */
    'event_model' => null,

    'event_id' => 'id',
    'timestamp' => 'created_at',
    'event_name' => 'action_type',

];

Usage

In code

$logPath = eventlog()->setupForSnipeIt()->setLogExporter(new OCEL1)->write();

Using the php artisan pm:dump command.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

dtdi / laravel-eventlog

Maintainers

Details