otrs -> rel-4_0 API documentation

NAME

Kernel::System::OTRSBusiness - OTRSBusiness deployment backend

SYNOPSIS

PUBLIC INTERFACE

• new()

  create an object. Do not use it directly, instead use:

  use Kernel::System::ObjectManager;
  local $Kernel::OM = Kernel::System::ObjectManager->new();
  my $RegistrationObject = $Kernel::OM->Get('Kernel::System::OTRSBusiness');
  

• OTRSBusinessIsInstalled()

  checks if OTRSBusiness is installed in the current system. That does not necessarily mean that it is also active, for example if the package is only on the database but not on the file system.

• OTRSBusinessIsAvailable()

  checks with cloud.otrs.com if OTRSBusiness is available for the current framework.

• OTRSBusinessIsAvailableOffline()

  retrieves the latest result of the BusinessVersionCheck cloud service that was stored in the system_data table.

  returns 1 if available.

• OTRSBusinessIsCorrectlyDeployed()

  checks if the OTRSBusiness package is correctly deployed or if it needs to be reinstalled.

• OTRSBusinessIsReinstallable()

  checks if the OTRSBusiness package can be reinstalled (if it supports the current framework version). If not, an update might be needed.

• OTRSBusinessIsUpdateable()

  checks with cloud.otrs.com if the OTRSBusiness package is available in a newer version than the one currently installed. The result of this check will be stored in the system_data table for offline usage.

• OTRSBusinessVersionCheckOffline()

  retrieves the latest result of the BusinessVersionCheck cloud service that was stored in the system_data table.

  my %Result = $OTRSBusinessObject->OTRSBusinessVersionCheckOffline();
  

  returns

  $Result = (
      OTRSBusinessUpdateAvailable      => 1,  # if applicable
      FrameworkUpdateAvailable         => 1,  # if applicable
  );
  

• OTRSBusinessGetDependencies()

  checks if there are any active dependencies on OTRSBusiness.

• OTRSBusinessEntitlementCheck()

  determines the OTRSBusiness entitlement status of this system as reported by cloud.otrs.com and stores it in the system_data cache.

  Returns 1 if the cloud call was successful.

• OTRSBusinessEntitlementStatus()

  Returns the current entitlement status.

  my $Status = $OTRSBusinessObject->OTRSBusinessEntitlementStatus(
      CallCloudService => 1,  # 0 or 1, call the cloud service before looking at the cache
  );
  
  $Status = 'entitled';   # everything is OK
  $Status = 'warning';    # last check was OK, and we are in the waiting period
  $Status = 'forbidden';  # not entitled (either because the server said so or because the last check was too long ago)
  

• OTRSBusinessContractExpiryDateCheck()

  checks for the warning period before the contract expires

  my $ExpiryDate = $OTRSBusinessObject->OTRSBusinessContractExpiryDateCheck();
  

  returns the ExpiryDate if a warning should be displayed

  $ExpiryDate = undef;                    # everything is OK, no warning
  $ExpiryDate = '2012-12-12 12:12:12'     # contract is about to expire, issue warning
  

• OTRSBusinessInstall()

  downloads and installs OTRSBusiness.

• OTRSBusinessReinstall()

  reinstalls OTRSBusiness from local repository.

• OTRSBusinessUpdate()

  downloads and updates OTRSBusiness.

• OTRSBusinessUninstall()

  removes OTRSBusiness from the system.

TERMS AND CONDITIONS

This software is part of the OTRS project (https://otrs.org/).

This software comes with ABSOLUTELY NO WARRANTY. For details, see the enclosed file COPYING for license information (GPL). If you did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.