ePages 6.15.1 - DE_EPAGES/Installer/API/SystemInfoReport/SystemInfoReportHandler.pm

Package DE_EPAGES::Installer::API::SystemInfoReport::SystemInfoReportHandler

This the install handler for all patch install functions.

Functions

_exportAsCalledBackgroundProcess
_exportByCallingBackgroundProzesses
_exportWithoutBackgroundProzess
exportReport

_exportAsCalledBackgroundProcess

exports the report of the report sections as a called background process will ask permission to delete output folder

Syntax
$SystemInfoReportHandler->_exportAsCalledBackgroundProcess( $Recursive, $OutputFolder, $aRoles, $aReportSections, $Role, $aStore );
Input
$Recursive (boolean)
this process is called recursive
$OutputFolder (string)
target folder for output
$aRoles (ref arry string)
array of all roles
$aReportSections (ref array string)
report sections, regulate the type of output (optional)
$Role (string)
role, regulate the type of output (optional)
$aStore (ref array string)
stores, regulate the type of output (optional)

_exportByCallingBackgroundProzesses

exports the report of the report sections parallel by calling background processes will ask permission to delete output folder

Syntax
$SystemInfoReportHandler->_exportByCallingBackgroundProzesses( $OutputFolder, $aRoles, $SkriptDir, $aReportSections, $Role );
Input
$OutputFolder (string)
target folder for output
$aRoles (string)
array of all roles | ref arry string
$input $SkriptDir | directory of getSystemInfo script
$aReportSections (ref array string)
report sections, regulate the type of output (optional)
$Role (string)
role, regulate the type of output (optional)

_exportWithoutBackgroundProzess

exports the report of the report sections sequentially in one process will ask permission to delete output folder sets standard values for role and report section if undef

Syntax
$SystemInfoReportHandler->_exportWithoutBackgroundProzess( $OutputFolder, $aRoles, $aReportSections, $aStore, $Role ) ;
Input
$OutputFolder (string)
target folder for output
$aRoles (ref arry string)
array of all roles
$aReportSections (ref array string)
report sections, regulate the type of output (optional)
$aStore (ref array string)
stores, regulate the type of output (optional)
$Role (string)
role, regulate the type of output (optional)

exportReport

exports the report of the report sections will ask permission to delete output folder sets standard values for role and report section if undef is able to call background processes

Syntax
$SystemInfoReportHandler->exportReport( $OutputFolder, $Role, $aReportSections, $aStore, $SkriptDir, $Background, $Recursive );
Input
$OutputFolder (string)
target folder for output
$Role (string)
role, regulate the type of output (optional)
$aReportSections (ref array string)
report sections, regulate the type of output (optional)
$aStore (string)
stores, regulate the type of output (optional) | ref array string
$input $SkriptDir | directory of getSystemInfo script
$Background (boolean)
use background processes to fetch every caregory simultaneously
$Recursive (boolean)
this process is called recursive