diff --git a/Documentation/portal-guide/source/portal-developer-guide/components/additional-components.rst b/Documentation/portal-guide/source/portal-developer-guide/components/additional-components.rst index ed3483e200e..bcaf0c6f515 100644 --- a/Documentation/portal-guide/source/portal-developer-guide/components/additional-components.rst +++ b/Documentation/portal-guide/source/portal-developer-guide/components/additional-components.rst @@ -3,52 +3,6 @@ Additional Components ===================== -.. _components-additional-component-task-analysis: - -Task Analysis -------------- - -.. _components-additional-component-task-analysis-introduction: - -Introduction -^^^^^^^^^^^^ - -The Portal's Task Analysis component provides features in accordance with the -user's permission :bdg-ref-warning:`🔑StatisticAnalyzeTask `. Refer to -:dev-url:`Security section in Cockpit -` to -analyze not only tasks but also cases. These features are: - -#. Sets of filters for both tasks and cases which allow to filter - and find tasks and cases easier. Additionally, user can create and - manage their own filter sets. - -#. Dynamic result table with lots of information for both task and case. - -#. Export results into an Excel files (currently we only support .xlsx - extension). - -|task-analysis| - -.. _components-additional-component-task-analysis-how-to-use: - -How to Use -^^^^^^^^^^ - -The Task Analysis component is integrated into the Statistics widget. You can -use this component directly when opening the Statistics widget. If you want to -use this component, you only have to redirect to the Task Analysis component -with the following code: - -.. code-block:: java - - import com.axonivy.portal.components.publicapi.ProcessStartAPI; - import java.util.HashMap; - import javax.faces.context.FacesContext; - - String taskAnalysisUrl = ProcessStartAPI.findRelativeUrlByProcessStartFriendlyRequestPath("Start Processes/PortalStart/showTaskAnalysis.ivp"); - FacesContext.getCurrentInstance().getExternalContext().redirect(taskAnalysisUrl); - .. _components-additional-component-global-growl: Global Growl @@ -136,6 +90,5 @@ This decorator offers the following parameters: :widths: 20 10 25 45 -.. |task-analysis| image:: ../../screenshots/components/task-analysis.png .. |example-global-growl-finished-task| image:: ../../screenshots/components/example-global-growl-finished-task.png .. |example-global-growl-cancelled-task| image:: ../../screenshots/components/example-global-growl-cancelled-task.png diff --git a/Documentation/portal-guide/source/portal-developer-guide/customization/default-chart-colors.rst b/Documentation/portal-guide/source/portal-developer-guide/customization/default-chart-colors.rst deleted file mode 100644 index c091a054dc2..00000000000 --- a/Documentation/portal-guide/source/portal-developer-guide/customization/default-chart-colors.rst +++ /dev/null @@ -1,134 +0,0 @@ -.. _customization-default-chart-colors: - -Default Chart Color -******************* - -.. _customization-default-chart-colors-introduction: - -Introduction ------------- - -In Portal, you can customize the default background chart , data labels and legend color. - -|default-chart-color| - -.. _override-Statistic-colors: - -Customization -------------- - -You can override chart, data label, and legend colors by re-defining the values of the variables in ``custom.css`` below: - -Statistic chart Task by priority -================================ - - ``--chart-label-default-exception-priority-color`` to override label color of exception priority task - - ``--chart-label-default-high-priority-color`` to override label color of high priority task - - ``--chart-label-default-normal-priority-color`` to override label color of normal priority task - - ``--chart-label-default-low-priority-color`` to override label color of low priority task - - ``--chart-default-exception-priority-color`` to override background color of exception priority task - - ``--chart-default-high-priority-color`` to override background color of high priority task - - ``--chart-default-normal-priority-color`` to override background color of normal priority task - - ``--chart-default-low-priority-color`` to override background color of low priority task - -Statistic chart Case by state -============================= - - ``--chart-label-default-created-case-color`` to override label color of created case - - ``--chart-label-default-running-case-color`` to override label color of running case - - ``--chart-label-default-done-case-color`` to override label color of done case - - ``--chart-label-default-failed-case-color`` to override label color of failed case - - ``--chart-default-created-case-color`` to override background color of created case - - ``--chart-default-running-case-color`` to override background color of running case - - ``--chart-default-done-case-color`` to override background color of done case - - ``--chart-default-failed-case-color`` to override background color of failed case - -Statistic chart Processed cases in time period -============================================== - - ``--chart-label-default-created-case-finish-task-color`` to override label color of created case - - ``--chart-label-default-running-case-finish-task-color`` to override label color of running case - - ``--chart-label-default-done-case-finish-task-color`` to override label color of done case - - ``--chart-label-default-failed-case-finish-task-color`` to override label color of failed case - - ``--chart-default-created-case-finish-task-color`` to override background color of created case - - ``--chart-default-running-case-finish-task-color`` to override background color of running case - - ``--chart-default-done-case-finish-task-color`` to override background color of done case - - ``--chart-default-failed-case-finish-task-color`` to override background color of failed case - -Statistic chart Done cases in time period -========================================= - - ``--chart-label-default-created-case-finish-time-color`` to override label color of created case - - ``--chart-label-default-running-case-finish-time-color`` to override label color of running case - - ``--chart-label-default-done-case-finish-time-color`` to override label color of done case - - ``--chart-label-default-failed-case-finish-time-color`` to override label color of failed case - - ``--chart-default-created-case-finish-time-color`` to override background color of created case - - ``--chart-default-running-case-finish-time-color`` to override background color of running case - - ``--chart-default-done-case-finish-time-color`` to override background color of done case - - ``--chart-default-failed-case-finish-time-color`` to override background color of failed case - -Statistic chart Elapsed time of done case -========================================= - - ``--chart-label-default-elapsed-time-color`` to override label color of elapsed time of done cases - - ``--chart-default-elapsed-time-color`` to override background color of elapsed time of done cases - -Statistic chart Task by expiry -============================== - - ``--chart-label-default-task-expiried-color`` to override label color of expired task - - ``--chart-label-default-task-today-color`` to override label color of today task - - ``--chart-label-default-task-week-color`` to override label color of this week task - - ``--chart-label-default-task-month-color`` to override label color of this month task - - ``--chart-label-default-task-year-color`` to override label color of this year task - - ``--chart-default-task-expiried-color`` to override background color of expired task - - ``--chart-default-task-today-color`` to override background color of today task - - ``--chart-default-task-week-color`` to override background color of this week task - - ``--chart-default-task-month-color`` to override background color of this month task - - ``--chart-default-task-year-color`` to override background color of this year task - - ``--chart-default-task-expiried-today-before-8-color`` to override background color of expired tasks today before 8th - - ``--chart-default-task-expiried-today-8-color`` to override background color of expired tasks today 8th - - ``--chart-default-task-expiried-today-9-color`` to override background color of expired tasks today 9th - - ``--chart-default-task-expiried-today-10-color`` to override background color of expired tasks today 10th - - ``--chart-default-task-expiried-today-11-color`` to override background color of expired tasks today 11th - - ``--chart-default-task-expiried-today-12-color`` to override background color of expired tasks today 12th - - ``--chart-default-task-expiried-today-13-color`` to override background color of expired tasks today 13th - - ``--chart-default-task-expiried-today-14-color`` to override background color of expired tasks today 14th - - ``--chart-default-task-expiried-today-15-color`` to override background color of expired tasks today 15th - - ``--chart-default-task-expiried-today-16-color`` to override background color of expired tasks today 16th - - ``--chart-default-task-expiried-today-17-color`` to override background color of expired tasks today 17th - - ``--chart-default-task-expiried-today-after-18-color`` to override background color of expired tasks today after 18th - - ``--chart-default-task-expiried-mon-color`` to override background color of expired tasks week on Monday - - ``--chart-default-task-expiried-tue-color`` to override background color of expired tasks week on Tueday - - ``--chart-default-task-expiried-wed-color`` to override background color of expired tasks week on Wednesday - - ``--chart-default-task-expiried-thu-color`` to override background color of expired tasks week on Thurday - - ``--chart-default-task-expiried-fri-color`` to override background color of expired tasks week on Friday - - ``--chart-default-task-expiried-sat-color`` to override background color of expired tasks week on Saturday - - ``--chart-default-task-expiried-sun-color`` to override background color of expired tasks week on Sunday - - ``--chart-default-task-expiried-first-week-color`` to override background color of expired tasks month in the first week - - ``--chart-default-task-expiried-second-week-color`` to override background color of expired tasks month in the second week - - ``--chart-default-task-expiried-third-week-color`` to override background color of expired tasks month in the third week - - ``--chart-default-task-expiried-fourth-week-color`` to override background color of expired tasks month in the fourth week - - ``--chart-default-task-expiried-fifth-week-color`` to override background color of expired tasks month in the fifth week - - ``--chart-default-task-expiried-jan-color`` to override background color of expired tasks year in the January - - ``--chart-default-task-expiried-feb-color`` to override background color of expired tasks year in the February - - ``--chart-default-task-expiried-mar-color`` to override background color of expired tasks year in the March - - ``--chart-default-task-expiried-apr-color`` to override background color of expired tasks year in the April - - ``--chart-default-task-expiried-may-color`` to override background color of expired tasks year in the May - - ``--chart-default-task-expiried-june-color`` to override background color of expired tasks year in the June - - ``--chart-default-task-expiried-july-color`` to override background color of expired tasks year in the July - - ``--chart-default-task-expiried-aug-color`` to override background color of expired tasks year in the August - - ``--chart-default-task-expiried-sep-color`` to override background color of expired tasks year in the September - - ``--chart-default-task-expiried-oct-color`` to override background color of expired tasks year in the October - - ``--chart-default-task-expiried-nov-color`` to override background color of expired tasks year in the November - - ``--chart-default-task-expiried-dec-color`` to override background color of expired tasks year in the December - -Statistic chart Cases by Category -================================= - - ``--chart-label-default-cases-by-category-color`` to override label color of cases by category - - ``--chart-default-cases-by-category-color`` to override background color of cases by category - -Legend color for Doughnut Chart -=============================== - - ``--chart-default-legend-color`` to override legend color of ``case by state``, ``processed cases in time period``, and ``done cases in time period`` chart - -In Portal home, you can override the color of the Statistic Carousel header by re-defining the value of the variables in ``custom.css`` below: - - - ``--statistic-panel-header`` to override background color of Carousel header - - ``--statistic-panel-header-border`` to override border color of Carousel header - -.. |default-chart-color| image:: images/default-chart-colors/default-chart-color.png diff --git a/Documentation/portal-guide/source/portal-developer-guide/customization/default-chart.rst b/Documentation/portal-guide/source/portal-developer-guide/customization/default-chart.rst deleted file mode 100644 index fbfd9b26818..00000000000 --- a/Documentation/portal-guide/source/portal-developer-guide/customization/default-chart.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _customization-default-chart: - -Default Chart -============= - -.. _customization-default-chart-introduction: - -Introduction ------------- - -In the Statistics page, by default, there is a chart named "Tasks by -Priority". However, you can create your default chart. - -.. _customization-default-chart-customization: - -Customization -------------- - -Default chart configuration is stored in -:dev-url:`Variables `. -Update variable :ref:`portal-statistic-charts` to customize the default charts. diff --git a/Documentation/portal-guide/source/portal-developer-guide/customization/index.rst b/Documentation/portal-guide/source/portal-developer-guide/customization/index.rst index a6ce55a6997..204f54924fc 100644 --- a/Documentation/portal-guide/source/portal-developer-guide/customization/index.rst +++ b/Documentation/portal-guide/source/portal-developer-guide/customization/index.rst @@ -18,8 +18,6 @@ You find ``portal-developer-examples`` in the engine demo mode or import them in task-delegation task-item-details case-item-details - default-chart - default-chart-colors change-password-process logout-process navigate-back diff --git a/Documentation/portal-guide/source/portal-developer-guide/customization/menu.rst b/Documentation/portal-guide/source/portal-developer-guide/customization/menu.rst index 75c94c0d2b2..6ae6e3cdd81 100644 --- a/Documentation/portal-guide/source/portal-developer-guide/customization/menu.rst +++ b/Documentation/portal-guide/source/portal-developer-guide/customization/menu.rst @@ -8,7 +8,7 @@ Menu And Default Homepage In User Profile Introduction ------------ -The Portal main menu has five default items: Dashboard, Processes, Tasks, Cases and Statistics. +The Portal main menu has four default items: Dashboard, Processes, Tasks and Cases. |default-menu-items| @@ -151,7 +151,7 @@ The basic JSON structure of a custom menu item Hide default menu items ----------------------- -You can hide four default menu items: Processes, Tasks, Cases and Statistics from the main menu +You can hide three default menu items: Processes, Tasks and Cases from the main menu by using :ref:`Portal permissions `. .. |default-menu-items| image:: ../../screenshots/dashboard/expanded-left-menu.png \ No newline at end of file diff --git a/Documentation/portal-guide/source/portal-developer-guide/customization/portal-style-customization-logos-colors-date-patterns.rst b/Documentation/portal-guide/source/portal-developer-guide/customization/portal-style-customization-logos-colors-date-patterns.rst index 4e1b3fed3e5..1a56037b3ba 100644 --- a/Documentation/portal-guide/source/portal-developer-guide/customization/portal-style-customization-logos-colors-date-patterns.rst +++ b/Documentation/portal-guide/source/portal-developer-guide/customization/portal-style-customization-logos-colors-date-patterns.rst @@ -111,10 +111,6 @@ You can customize the Portal styles in ``custom.css``. .. warning:: - Do not change ``font-family`` property values. - - Limitation: the task priority color customization hasn't changed the task priority colors in statistic. - - If you want to custom color of statistics please refer to :ref:`Override Statistic color ` - .. |css_variable| raw:: html CSS Variable \ No newline at end of file diff --git a/Documentation/portal-guide/source/portal-developer-guide/installation/index.rst b/Documentation/portal-guide/source/portal-developer-guide/installation/index.rst index 9d5e555f951..aa6d7fed6cc 100644 --- a/Documentation/portal-guide/source/portal-developer-guide/installation/index.rst +++ b/Documentation/portal-guide/source/portal-developer-guide/installation/index.rst @@ -328,7 +328,6 @@ Migrate 9.3 To 9.4 #. The ``DefaultChartColor.p.json`` subprocess has been removed, in case you use it in your project, please remove override this subprocess and switch to using :dev-url:`Engine Branding ` to customize chart, data labels, legend color. - Refer to :ref:`Default chart colors `. #. Deploy :download:`portal-migration-9.4.0.iar ` project to your Ivy application and run it by access link ``your_host/your_application/pro/portal-migration/175F92F71BC45295/startMigrateConfiguration.ivp`` @@ -355,7 +354,6 @@ Migrate 9.2 To 9.3 * Run migration process only once #. We changed the way to navigate to Task Analysis component. Process ``Start Processes/TaskAnalysis/start.ivp`` is moved to new place ``Start Processes/PortalStart/showTaskAnalysis.ivp``. - Refer to :ref:`Task Analysis call` for details. #. We moved the configuration of announcement, thirdparty applications, default statistic charts, application favorite processes, public external links and express processes from the BusinessData tovariables. @@ -482,6 +480,11 @@ Release notes This part lists all relevant changes since the last official product releases of |ivy|. +Changes in 12 +------------- + +- The old statistic chart is removed, use the new :ref:`statistic-chart` instead. + Changes in 11.2.0 ----------------- @@ -525,7 +528,7 @@ Changes in 9.4 - Introduced the ``Formatting language setting`` to format values, for example the decimal separator is displayed differently in different regions of the world. -- Removed subprocess ``DefaultChartColor.p.json``, introduced some Portal variables for customizing the default chart color. See details: :ref:`Default chart colors `. +- Removed subprocess ``DefaultChartColor.p.json``, introduced some Portal variables for customizing the default chart color. - Introduce some components in new ``portal-components`` project. diff --git a/Documentation/portal-guide/source/portal-developer-guide/permissions/index.rst b/Documentation/portal-guide/source/portal-developer-guide/permissions/index.rst index 43929dc6803..44631d5f67a 100644 --- a/Documentation/portal-guide/source/portal-developer-guide/permissions/index.rst +++ b/Documentation/portal-guide/source/portal-developer-guide/permissions/index.rst @@ -177,11 +177,6 @@ Portal General Permissions - Granted to role Everybody by default -- _`AccessFullStatisticsList` - - Permission to access the statistics section. See :ref:`full-statistic-list`. - - - Granted to role Everybody by default - - _`TaskCaseAddNote` - Permission to add notes to a task/case @@ -261,19 +256,6 @@ Portal Absence And Substitute Permissions - _`UserReadSubstitutes` - Permission to read substitutes of all users - -Portal Statistic Permissions ----------------------------- - -- _`StatisticAddDashboardChart` - - Permission to add dashboard charts - - - Granted to role Everybody by default - -- _`StatisticAnalyzeTask` - - Permission to analyze, filter tasks and export data to excel for advanced analysis - - Portal Express Permissions -------------------------- diff --git a/Documentation/portal-guide/source/portal-developer-guide/settings/index.rst b/Documentation/portal-guide/source/portal-developer-guide/settings/index.rst index fc701067f45..fae888488dd 100644 --- a/Documentation/portal-guide/source/portal-developer-guide/settings/index.rst +++ b/Documentation/portal-guide/source/portal-developer-guide/settings/index.rst @@ -247,13 +247,6 @@ Other Permissions | Express | Create Express workflow | :bdg-ref-warning:`🔑ExpressCreateWorkflow ` | | | | (assigned to role Everybody by default) | +-----------+---------------------------------+---------------------------------------------------------------------------------------+ - | Statistics| Add dashboard | :bdg-ref-warning:`🔑StatisticAddDashboardChart ` | - | | | (assigned to role Everybody by default) | - | +---------------------------------+---------------------------------------------------------------------------------------+ - | | Analyze, filter tasks | :bdg-ref-warning:`🔑StatisticAnalyzeTask ` | - | | and export data to excel | | - | | for advanced analysis | | - +-----------+---------------------------------+---------------------------------------------------------------------------------------+ | Portal | Access to full process | :bdg-ref-warning:`🔑AccessFullProcessList ` | | permission| list, it's "Processes" on the | | | | left menu and link "Show all | | @@ -267,11 +260,6 @@ Other Permissions | | Access to full case list, it's | :bdg-ref-warning:`🔑AccessFullCaseList ` | | | "Cases" on the left menu | | | +---------------------------------+---------------------------------------------------------------------------------------+ - | | Access to statistics it's | :bdg-ref-warning:`🔑AccessFullStatisticsList ` | - | | "Statistics" on the left menu | | - | | and link "Show all charts" on | | - | | Dashboard | | - | +---------------------------------+---------------------------------------------------------------------------------------+ | | Add note to task/case | :bdg-ref-warning:`🔑TaskCaseAddNote ` | | +---------------------------------+---------------------------------------------------------------------------------------+ | | Display show more note | :bdg-ref-warning:`🔑TaskCaseShowMoreNote ` | diff --git a/Documentation/portal-guide/source/portal-user-guide/accessibility/documents/shortcuts.csv b/Documentation/portal-guide/source/portal-user-guide/accessibility/documents/shortcuts.csv index d62f09c3e02..a7cde353a2f 100644 --- a/Documentation/portal-guide/source/portal-user-guide/accessibility/documents/shortcuts.csv +++ b/Documentation/portal-guide/source/portal-user-guide/accessibility/documents/shortcuts.csv @@ -3,6 +3,5 @@ Alt + 1,Focus on the Dashboard Alt + 2,Focus on the Process Alt + 3,Focus on the Task Alt + 4,Focus on the Case -Alt + 5,Focus on the Statistics -Alt + 6,Focus on the Search icon -Alt + 7,Focus on the User Settings \ No newline at end of file +Alt + 5,Focus on the Search icon +Alt + 6,Focus on the User Settings \ No newline at end of file diff --git a/Documentation/portal-guide/source/portal-user-guide/admin-settings/documents/available_settings.csv b/Documentation/portal-guide/source/portal-user-guide/admin-settings/documents/available_settings.csv index 533856ff081..b3da60d66b6 100644 --- a/Documentation/portal-guide/source/portal-user-guide/admin-settings/documents/available_settings.csv +++ b/Documentation/portal-guide/source/portal-user-guide/admin-settings/documents/available_settings.csv @@ -5,7 +5,7 @@ Portal.CaseDetails.HideUploadDocumentForDoneCase,FALSE,Set to true to deny uploa Portal.CaseDetails.ShowDurationTime,TRUE,For switch on/off the display of the duration time in case details page. Portal.Cases.DisableCount,FALSE,Set to true to disable counting case in case list. Portal.Cases.EnableOwner,FALSE,"| Set to true to enable filtering case owner when cases are queried. This setting affects all case -| queries e.g. for case list, global search, statistic." +| queries e.g. for case list, global search." Portal.Cases.SortDirection,Sort descending,Default sort direction of case list. Portal.Cases.SortField,Case Id,Default sort field of the case list. Portal.Chat.EnableGroup,FALSE,Set this property to true to enable group chat function. @@ -17,8 +17,7 @@ Portal.Chat.ResponseTimeout,0,"| Chat response timeout in seconds, default value Portal.ClientSideTimeout,0,"| Client side timeout in minutes. Has to be more than 0 and less than the server side timeout (e.g. 25 minutes). | Default value is 0, which means that the default client side timeout is applied. | Default client side timeout is server side timeout minus 3 minutes." -Portal.Dashboard.HideStatisticWidget,FALSE,"If true, hide Statistic widget from homepage and application menu." -Portal.DateTimeFormat.DateFilterWithTime,FALSE,"Set to true to enable date filtering with time. This setting affects on task list, case list, and statistics." +Portal.DateTimeFormat.DateFilterWithTime,FALSE,"Set to true to enable date filtering with time. This setting affects task list and case list." Portal.DateTimeFormat.HideTime,FALSE,Set to true to hide hours and minutes next to date. Portal.DateTimeFormat.HideYear,FALSE,"Set to true, year will be hidden, otherwise it will be shown." Portal.DisplayMessageAfterFinishTask,TRUE,A feedback message will be displayed after user finishes or leaves a task. @@ -59,7 +58,6 @@ Portal.ProcessViewer,TRUE,"Set this property to true to display process viewer o Portal.Histories.HideRelatedCaseInfo,FALSE,"If true, case history does not display the related case information in the history table." Portal.ShowErrorLogToConsole,FALSE,"If true, write error log to browser console." Portal.ShowAvatar,TRUE,"If true, switch on the display of user/role avatars." -Portal.StatisticChartScalingInterval,0,"Interval in seconds to do periodic statistic chart scaling requests. If the interval value is less than 10, periodic statistic chart scaling is disabled." Portal.RoleDirectChildrenLimit,50,"| Controls the number of direct child roles that are shown in the Role Management tab. | Valid numbers: 10, 50, 100." Portal.RoleParentLimit,10,"| Controls the number of parent roles that are shown when filtering roles in the Role Management tab. @@ -78,4 +76,4 @@ Portal.UserMenu.BaseQRCodeUrl,"",Set Base URL for QR code to display. Portal.UserMenu.AppleStoreURL,"",Set URL to download Axon Ivy mobile app on Apple Store. Portal.UserMenu.GooglePlayURL,"",Set URL to download Axon Ivy mobile app on Google Play. Portal.GlobalSearchScopeCategories,"PROCESSES,TASKS,CASES",Defining the types that the global search will search for. -Portal.Cases.HideCaseCreator,FALSE,"Set to true to hide case creator in case list, case widget and case details.This setting affects all case queries, e.g. for case list, global search, statistic." \ No newline at end of file +Portal.Cases.HideCaseCreator,FALSE,"Set to true to hide case creator in case list, case widget and case details.This setting affects all case queries, e.g. for case list, global search." \ No newline at end of file diff --git a/Documentation/portal-guide/source/portal-user-guide/admin-settings/index.rst b/Documentation/portal-guide/source/portal-user-guide/admin-settings/index.rst index 70fb67086be..b460f7a1a0b 100644 --- a/Documentation/portal-guide/source/portal-user-guide/admin-settings/index.rst +++ b/Documentation/portal-guide/source/portal-user-guide/admin-settings/index.rst @@ -1,5 +1,13 @@ .. _admin-settings: +.. raw:: html + + + Admin Settings ************** diff --git a/Documentation/portal-guide/source/portal-user-guide/full-statistic-list/index.rst b/Documentation/portal-guide/source/portal-user-guide/full-statistic-list/index.rst deleted file mode 100644 index 45d561938ca..00000000000 --- a/Documentation/portal-guide/source/portal-user-guide/full-statistic-list/index.rst +++ /dev/null @@ -1,287 +0,0 @@ -.. _full-statistic-list: - -Full Statistics Page -******************** - -One way to consume statistics is through your personal dashboard. If you need a deeper insight in what is going on, the -**Full Statistics** page provides you with the perfect toolset. You can -consume statistics and charts here at one glance and have the chance to set up -your own statistics. You can reach the page by using the -:guilabel:`Statistics` link in the |ivy| Portal menu. - -.. note:: - - Grant permission :bdg-ref-warning:`🔑AccessFullStatisticsList ` to allow a user to see the full statistics list (:guilabel:`Statistics`) in the |ivy| Portal menu. - - -.. hint:: - The statistics allow you to evaluate case and task data only. Business data - from your processes is not available in these statistics and must be - considered separately. - -|navigate-to-full-statistics-page| - -On the **Full Statistics** page you see all charts that were previously -created. Each chart provides you with the following features: - -|full-statistics-page-chart-detail| - -#. The heading of the chart - -#. An |info-icon| **Info** icon, providing you with the configuration of - the chart - - |full-statistics-page-chart-info-detail| - -#. Arrow buttons (|arrow-right-icon|, |arrow-left-icon|) depending - on the position of the chart to allow you rearrangement according to - your personal needs - -#. The chart itself. It might provide you with a drill down function - down to the task level. - -#. The legend, explaining the part of the charts - -.. _howto-create-chart: - -HowTo: Create chart -------------------- - -#. Click on the link ``Add new chart``. - -#. You are routed to the Chart Configuration page. - -#. Select one of the available chart types (see Available charts). - -#. Select and configure one or more of the available filters (see Chart filter criteria). - -#. Click :guilabel:`Add to dashboard`. - -#. The :guilabel:`Add statistic chart to dashboard` dialog is opened. - -#. Enter unique names in supported languages for the chart. - -#. Create the chart by clicking :guilabel:`Ok`. - -|charts-configuration-page| - -**Available charts** - -|full-statistics-page| - -.. centered:: Chart types - -+-----------------------+-----------------------+-----------------------+ -| Name | Type | Description | -+=======================+=======================+=======================+ -| Tasks by priority | Doughnut chart | Displays all tasks | -| | | assigned to a user or | -| | | a belonged role | -| | | categorized by their | -| | | priority (Low, | -| | | Normal, High, | -| | | Exception). The | -| | | values are shown in | -| | | percentages. | -+-----------------------+-----------------------+-----------------------+ -| Case by state | Doughnut chart | Displays all cases | -| | | belonging to a user | -| | | or a role categorized | -| | | by their state (In | -| | | progress, Done). The | -| | | values are shown in | -| | | percentages. | -+-----------------------+-----------------------+-----------------------+ -| Tasks by expiry | Bar chart | Displays all tasks | -| | | assigned to a user or | -| | | a belonged role | -| | | categorized by expiry | -| | | time (Today, This | -| | | Week, This Month, | -| | | This Year). The values| -| | | are the sum of tasks | -| | | in the respective | -| | | categories. | -+-----------------------+-----------------------+-----------------------+ -| Elapsed time of done | Bar chart | Displays the relative | -| cases. | | elapsed time of all | -| | | done cases belonging | -| | | to a user or a role | -| | | categorized by their | -| | | Case Category. The | -| | | values are shown in | -| | | percentages. | -+-----------------------+-----------------------+-----------------------+ -| Processed cases in | Doughnut chart | Displays all cases | -| time period | | belonging to a user | -| | | or a role, where at | -| | | least one task was | -| | | done during the | -| | | selected time period. | -| | | In addition, the | -| | | chart shows if the | -| | | related case is still | -| | | in progress or | -| | | already done. The | -| | | values are shown in | -| | | percentages. | -+-----------------------+-----------------------+-----------------------+ -| Done cases in time | Doughnut chart | Displays all cases | -| period | | belonging to a user | -| | | or a role, which were | -| | | done during the | -| | | selected time period. | -| | | The values are shown | -| | | in percentages. | -+-----------------------+-----------------------+-----------------------+ -| Cases by category | Bar chart | Displays all cases | -| | | belonging to a user | -| | | or a role categorized | -| | | by their Case Category| -| | | , where cases were in | -| | | progress, or already | -| | | done during the | -| | | selected time period. | -| | | The values are the | -| | | sum of cases in the | -| | | respective categories.| -+-----------------------+-----------------------+-----------------------+ - - -.. centered:: Chart filter criteria - -+-----------------------------------+-----------------------------------+ -| Filter | Description | -+===================================+===================================+ -| Time period | Select a predefined time filter | -| | (last month, last week, etc.) or | -| | set a custom filter selecting a | -| | fixed time period with a date | -| | picker. | -+-----------------------------------+-----------------------------------+ -| Case categories | Select which case categories | -| | should be included in the chart. | -| | If you select “Select all”, also | -| | new categories created in the | -| | future will be included in the | -| | chart. | -+-----------------------------------+-----------------------------------+ -| Roles | Select which roles involved in a | -| | case/task should be included in | -| | the chart. If you select “Select | -| | all”, also new roles created in | -| | the future will be included in | -| | the chart. | -+-----------------------------------+-----------------------------------+ -| Workflow states | Select which status/statuses | -| | shall be analyzed (Created, In | -| | Progress, Done). | -+-----------------------------------+-----------------------------------+ -| Task priorities | Select which task categories | -| | should be included in the chart. | -+-----------------------------------+-----------------------------------+ -| Custom fields | If some business specific data is | -| | included in these | -| | custom fields, you can select | -| | these fields for further | -| | filtering. | -+-----------------------------------+-----------------------------------+ - -Task analysis -------------- - -Portal provides lots of statistic charts, but maybe your business needs further analysis. Therefore, Portal provides Task Analysis that -helps you query tasks with filters, then you could export data to excel for further analysis. - -.. important:: - Grant permission :bdg-ref-warning:`🔑StatisticAnalyzeTask ` to allow a user to analyze statistics. - -HowTo: Access task analysis -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -On the Full Statistics page, click on ``Task Analysis``. - -|navigate-to-task-analysis| - -The Task Analysis page is displayed: - -|task-analysis| - -.. _task-analysis-filter-tasks: - -HowTo: Filter tasks -^^^^^^^^^^^^^^^^^^^ - -#. Click on :guilabel:`More options` of :guilabel:`Task filters` or :guilabel:`More options` of :guilabel:`Case filters` to select one of the available filters. - -#. Click on the newly added filter and configure it. - -#. Add more filters by clicking on :guilabel:`More options` again. - -#. To reset to no filters, click on :guilabel:`Reset`. - -#. Drop filters by clicking on the |delete-circle-icon| icon next to - the filter. - -#. When finished, click on :guilabel:`Apply filters`. - -|filtered-tasks| - -HowTo: Create new filter -^^^^^^^^^^^^^^^^^^^^^^^^ - -#. Filter tasks as described in :ref:`task-analysis-filter-tasks`. - -#. Click on :guilabel:`Save filter`. - -#. The dialog :guilabel:`Save filter` is opened. - - |saved-filter| - -#. Under :guilabel:`Filter name`, provide a recognizable name for the filter. - -#. Under :guilabel:`Filter visibility`, you can select if the filter is only - visible to you or shall be available to all users. - -#. Save the filter by clicking on :guilabel:`Ok`. - -.. hint:: - - #. You may also start the creation of a new filter by selecting an existing - filter first, reconfiguring it and saving it. - - #. Depending on your permissions you might only be allowed to save filters for - yourself. - -.. _task-analysis-display-tasks: - -HowTo: Configure displayed tasks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -#. To choose columns to display, click on :guilabel:`Manage columns`. Then you could choose displayed columns by checking the related checkboxes. - -#. To sort data, click on the column header. To change sort direction, click on that column header one more time. - Note that some columns do not support sorting. - -HowTo: Export to excel -^^^^^^^^^^^^^^^^^^^^^^ - -#. All the data that you filtered with selected columns and sort order will be exported. - Refer to :ref:`task-analysis-filter-tasks` and :ref:`task-analysis-display-tasks` for configuration. - -#. In Task Analysis page, click on ``Export to Excel``. - -#. You could use exported excel file to do further analysis by excel or import it to third-party applications to analyze more. - - -.. include:: ../includes/_common-icon.rst - -.. |navigate-to-full-statistics-page| image:: ../../screenshots/statistic/navigate-to-full-statistics-page.png -.. |full-statistics-page-chart-detail| image:: ../../screenshots/statistic/chart-detail-with-annotation.png -.. |full-statistics-page-chart-info-detail| image:: ../../screenshots/statistic/chart-info-dialog.png -.. |charts-configuration-page| image:: ../../screenshots/statistic/chart-creation-dialog.png -.. |full-statistics-page| image:: ../../screenshots/statistic/available-charts.png -.. |navigate-to-task-analysis| image:: ../../screenshots/statistic/task-analysis/navigate-to-task-analysis.png -.. |task-analysis| image:: ../../screenshots/statistic/task-analysis/task-analysis.png -.. |filtered-tasks| image:: ../../screenshots/statistic/task-analysis/filtered-tasks.png -.. |saved-filter| image:: ../../screenshots/statistic/task-analysis/saved-filter.png diff --git a/Documentation/portal-guide/source/portal-user-guide/index.rst b/Documentation/portal-guide/source/portal-user-guide/index.rst index 77dc4821f38..a5c5160dcc7 100644 --- a/Documentation/portal-guide/source/portal-user-guide/index.rst +++ b/Documentation/portal-guide/source/portal-user-guide/index.rst @@ -14,7 +14,6 @@ User Guide process-information/index full-task-list/index full-case-list/index - full-statistic-list/index my-profile/index admin-settings/index axon-ivy-express/index diff --git a/Documentation/portal-guide/source/portal-user-guide/new-dashboard/index.rst b/Documentation/portal-guide/source/portal-user-guide/new-dashboard/index.rst index d492e0ec457..dc239f6ad74 100644 --- a/Documentation/portal-guide/source/portal-user-guide/new-dashboard/index.rst +++ b/Documentation/portal-guide/source/portal-user-guide/new-dashboard/index.rst @@ -26,10 +26,6 @@ The following default widgets are available: #. **Process viewer widget**: This widget provides a visual representation of the process flow. -#. **Legacy statistic chart widget**: This widget provides graphical display of legacy statistical data. - -#. **Statistic chart widget**: This widget provides graphical display of statistical data. - #. **Client Statistic chart widget**: This widget provides graphical display of client statistical data. #. **Welcome widget**: This widget greets the user based on the local time and enables a friendlier approach. diff --git a/Documentation/portal-guide/source/portal-user-guide/portal-header/index.rst b/Documentation/portal-guide/source/portal-user-guide/portal-header/index.rst index 2ef2db626e3..9a3c8742f5d 100644 --- a/Documentation/portal-guide/source/portal-user-guide/portal-header/index.rst +++ b/Documentation/portal-guide/source/portal-user-guide/portal-header/index.rst @@ -27,7 +27,7 @@ needs. These features are described in the following sections below. Admin Settings -------------- -Menu entry :ref:`admin-settings` is only available for users have role AXONIVY_PORTAL_ADMIN. +Menu entry :ref:`Admin Settings ` is only available for users who have role AXONIVY_PORTAL_ADMIN. My profile ----------