Class EventAnalyticsUtil


  • public class EventAnalyticsUtil
    extends Object
    Event analytics utils.
    Since:
    11.0.0
    Version:
    $Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $
    • Constructor Detail

      • EventAnalyticsUtil

        public EventAnalyticsUtil()
    • Method Detail

      • getReport

        public static EventAnalyticsReport getReport​(String reportId,
                                                     boolean translateTitleOfStdReport)
                                              throws PortalException
        Returns the given report.
        Parameters:
        reportId - the report identifier.
        translateTitleOfStdReport - indicates whether the report title translation should be performed.
        Returns:
        the given report
        Throws:
        PortalException
        Since:
        14.1.0
      • getStandardDashboardByType

        public static EventAnalyticsDashboard getStandardDashboardByType​(String dashboardType)
                                                                  throws PortalException
        Returns the standard dashboard by its type.
        Parameters:
        dashboardType - the dashboard type.
        Returns:
        the standard dashboard by its type.
        Throws:
        PortalException
        Since:
        11.2.0
      • localize

        public static String localize​(String title)
                               throws PortalException
        Translates the given string.
        Parameters:
        title - the string to be translated.
        Returns:
        the translated string.
        Throws:
        PortalException
        Since:
        11.2.0
      • isStandardReportId

        public static boolean isStandardReportId​(String reportId)
        Returns whether the given report identifier is a standard report identifier.
        Parameters:
        reportId - the report identifier.
        Returns:
        whether the given report identifier is a standard report identifier.
        Since:
        11.2.0
      • isStandardDashboardType

        public static boolean isStandardDashboardType​(String type)
        Check is dashboard is standard by type.
        Parameters:
        type - the dashboard.
        Returns:
        true whether dashboard type is of standard dashboard.
        Since:
        12.2.0
      • addStandardDashBoardsAndAllStandartReports

        public static void addStandardDashBoardsAndAllStandartReports​(String... dashboardType)
                                                               throws Exception
        Add standard dashboard by types passed in parameters in all service instances. This method also adds all standards reports that are missing in each service instance. WARNING, this is user in PostUpgradeTaskManager in step 31.
        Parameters:
        dashboardType - the dash boards type standards that be will add in all service instance.
        Throws:
        Exception
        Since:
        12.2.0
      • createStandardReportsAndDashboards

        public static void createStandardReportsAndDashboards​(String serviceInstanceId)
                                                       throws PortalException
        Creates the standard definitions for the given service instance.
        Parameters:
        serviceInstanceId - the service instance identifier.
        Throws:
        PortalException
        Since:
        11.0.0
      • canInheritReport

        public static boolean canInheritReport​(String reportId,
                                               String requestServiceInstanceId)
                                        throws PortalException
        Returns whether the service instance config can inherit the report.
        Parameters:
        reportId - the report to perform the validation.
        requestServiceInstanceId - the request service instance to validate the inheritance.
        Returns:
        whether the service instance config can inherit the report.
        Throws:
        PortalException
        Since:
        14.0.0
      • getParentNestedField

        public static Optional<CompositeDocumentTypeField> getParentNestedField​(DocumentTypeField field)
        Returns an optional parent nested object of the given field.
        Parameters:
        field - the field
        Returns:
        an optional parent nested object of the given field.
        Since:
        14.0.0
      • getStandardReportByTitle

        public static Optional<EventAnalyticsReport> getStandardReportByTitle​(String title,
                                                                              String serviceInstanceId)
                                                                       throws PortalException
        Returns the standard report by the given title and service instance identifier.
        Parameters:
        title - the title
        serviceInstanceId - the service instance identifier
        Returns:
        the report
        Throws:
        PortalException
        Since:
        14.1.0
      • clearStandardReportsCache

        public static void clearStandardReportsCache​(String serviceInstanceId)
                                              throws PortalException
        Clears the standard reports cache by the given service instance id.
        Parameters:
        serviceInstanceId -
        Throws:
        PortalException
        Since:
        14.1.0
      • getDashboardTemplateInstancesIds

        public static Set<String> getDashboardTemplateInstancesIds()
                                                            throws PortalException
        Returns the dashboards template instances identifiers.
        Returns:
        the dashboards template instances identifiers.
        Throws:
        PortalException
        Since:
        14.1.0
      • isDashboardTemplateInstance

        public static boolean isDashboardTemplateInstance​(ServiceInstanceConfig serviceInstance)
                                                   throws PortalException
        Returns a boolean indicating if the given service instance is a dashboard template one.
        Parameters:
        serviceInstance - the service instance
        Returns:
        a boolean indicating if the given service instance is a dashboard template one.
        Throws:
        PortalException
        Since:
        14.1.0
      • isDashboardTemplateInstance

        public static boolean isDashboardTemplateInstance​(String serviceInstanceId)
                                                   throws PortalException
        Returns a boolean indicating if the given service instance is a dashboard template one.
        Parameters:
        serviceInstanceId - the service instance identifier.
        Returns:
        a boolean indicating if the given service instance is a dashboard template one.
        Throws:
        PortalException
        Since:
        14.1.0
      • clearDashboardTemplateInstancesCache

        public static void clearDashboardTemplateInstancesCache()
                                                         throws PortalException
        Clears dashboard template instances cache.
        Throws:
        PortalException
        Since:
        14.1.0