Enterprise distribution, reporting dashboard, custom reporting functionality - done

[kensoh]

"Can definitely add feature for distribution, it would help small teams and enterprise which may not have access to bloated enterprise tools and licences on tool distribution."

[kensoh]

The following lines in tagui/src/tagui_report.php is where users can change to output the reporting summary. And at the end of that file is where the individual log files are written.

https://github.com/kelaberetiv/TagUI/blob/acae7faa290ded9ee1304af76adbec0a5ff20312/src/tagui_report.php#L39

I think it'll be good if we make this as an option configurable by users, instead of them having to modify the files or maintain their own fork of TagUI. I'm assuming on users' centralised server, a program can write files to it directly by specifying the intranet network path and file to write to.

[kensoh]

Enterprise distribution is tracked in issue #955 on installation thru installer / script

Statistics and reporting is tracked in issue #958 on Microsoft Excel plug-in v3 with a reporting dashboard

Security and governance is tracked at this issue to review industry best practices - #1028

[kensoh]

So outstanding for this issue is having an option to set where to store report summary and log files

[kensoh]

Evaluate the concept of setup + teardown

[kensoh]

added enterprise security section in readme

[kensoh]

https://github.com/kelaberetiv/TagUI#enterprise-security-by-design

[kensoh]

Above commit improves colour coding for report option -

[kensoh]

Considering adding new fields like user_id and link to error image file

[kensoh]

Above commit adds a new USER_ID column to report summary. The format will be workgroup\userid

[kensoh]

If you are using TagUI v6.46 and above, you can get this update with tagui update command or MS Word plug-in Update TagUI button. You can get TagUI v6.46 from this installation page, or manually unzip this zip file to overwrite your existing installation (drag all the folders and files under TagUI-master\src to your existing tagui\src folder).

[kensoh]

Above commit will embed the error screenshot (if any) into the HTML log file when user runs with -report option, for eg -

[kensoh]

If you are using TagUI v6.46 and above, you can get this update with tagui update command or MS Word plug-in Update TagUI button. You can get TagUI v6.46 from this installation page, or manually unzip this zip file to overwrite your existing installation (drag all the folders and files under TagUI-master\src to your existing tagui\src folder).

[kensoh]

Above commit adds a custom reporting section to tagui\src\tagui (macOS/Linux) and tagui\src\tagui.cmd (Windows).

It is not viable for configuration text file to do custom reporting, eg sending data and files to a central server or API. This is because the range of what to be done is broad and differs from organisation to organisation. Also, having this setting simply in a text file would increase the chance of a central IT config being tampered by end-users.

Below approach lets central IT make the configuration themselves as needed before distribution and installation. And with this approach it is much harder for the same end-user to tamper for malicious purpose, since it is within a batch/bash script.

# do custom reporting here with OS commands, built-in curl or your programming language
# for eg you can move files to your central server or post data somewhere using your API
# "tagui_report.csv" - use this for the TagUI report summary CSV file
# "$tagui_user_id" - use this for the running user workgroup\userid
# "$1.html" - use this for the detailed execution HTML log
# "${1%????}_error.png" - use this for error image (if any)

rem do custom reporting here with OS commands, built-in curl or your programming language
rem for eg you can move files to your central server or post data somewhere using your API
rem "tagui_report.csv" - use this for the TagUI report summary CSV file
rem "!tagui_user_id!" - use this for the running user workgroup\userid
rem "%flow_file%.html" - use this for the detailed execution HTML log
rem "%flow_file:~0,-4%_error.png" - use this for error image (if any)

Fyi @marcelocecin and @ruthtxh on this approach above.

[kensoh]

If you are using TagUI v6.46 and above, you can get this update with tagui update command or MS Word plug-in Update TagUI button. You can get TagUI v6.46 from this installation page, or manually unzip this zip file to overwrite your existing installation (drag all the folders and files under TagUI-master\src to your existing tagui\src folder).

[kensoh]

Closing since this change has made its way into the latest packaged release.