diff --git a/Documentation/portal-guide/source/portal-developer-guide/dashboard/new-dashboard-task-widget.rst b/Documentation/portal-guide/source/portal-developer-guide/dashboard/new-dashboard-task-widget.rst index ef82501cd1d..1670bcbaf8a 100644 --- a/Documentation/portal-guide/source/portal-developer-guide/dashboard/new-dashboard-task-widget.rst +++ b/Documentation/portal-guide/source/portal-developer-guide/dashboard/new-dashboard-task-widget.rst @@ -31,6 +31,7 @@ Below is a sample JSON definition of a task widget in the Portal dashboard "rowsPerPage": 20, "showWidgetInfo": true, "showFullscreenMode": true, + "isTopMenu": false, "columns": [ { "field": "start" @@ -92,7 +93,7 @@ The basic JSON structure of a Task widget ``sortField``: default sort field for the widget - ``sortDescending``: sort direction of the default sort field. The default value is "false" (sort ascending) + ``sortDescending``: sort direction of the default sort field. The default value is ``false`` (sort ascending) ``rowsPerPage``: maximum number of tasks can be displayed on one page of the task widget. The default value is 10 rows per page @@ -101,6 +102,10 @@ The basic JSON structure of a Task widget ``showFullscreenMode``: visibility of the fullscreen mode icon. The default value is ``true``, set to ``false`` to hide the icon + ``isTopMenu``: if the value is ``true``, the dashboard appears as a top-level item in the navigation bar. + If the value is ``false``, it appears as a sub-item under the `Dashboard` menu. + The default value is ``false``. + ``columns``: column configurations for each of the columns in the widget. You can predefine filters, styles, visibility,... of columns and define custom columns, too: 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 9aa72f939f2..038e8e9c6e5 100644 --- a/Documentation/portal-guide/source/portal-developer-guide/installation/index.rst +++ b/Documentation/portal-guide/source/portal-developer-guide/installation/index.rst @@ -482,6 +482,8 @@ Changes in 12 - The old statistic chart is removed, use the new :ref:`statistic-chart` instead. - Introduce the component IFrameTaskConfig to configure IFrame tasks. Refer to :ref:`iframe-configure-template` for more information. +- The :ref:`full task list page ` has been redesigned to align with the concept of a dashboard task widget. + It now functions as a dashboard with a single, full-width task widget. To configure it, you can adjust it like any other task widget. Changes in 11.2.0 ----------------- diff --git a/Documentation/portal-guide/source/portal-user-guide/dashboard-configuration/index.rst b/Documentation/portal-guide/source/portal-user-guide/dashboard-configuration/index.rst index dab2eae210d..893e27b4b68 100644 --- a/Documentation/portal-guide/source/portal-user-guide/dashboard-configuration/index.rst +++ b/Documentation/portal-guide/source/portal-user-guide/dashboard-configuration/index.rst @@ -148,6 +148,8 @@ How to: add public dashboard #. The :guilabel:`Create new public dashboard` dialog is opened. #. Enter the mandatory title, permissions to see the public dashboard and the optional description for the public dashboard. + If the `Top Menu Item` checkbox is checked, the dashboard appears as a top-level item in the navigation bar. + If unchecked, it appears as a sub-item under `Dashboard` menu item. #. Create the public dashboard by selecting |add-icon| Create dashboard. @@ -180,6 +182,8 @@ How to: import public dashboard #. Press the Select button and choose the JSON file that contains the dashboard you want to import. #. Edit the mandatory title, permissions to see the public dashboard and the optional description for the public dashboard. + If the `Top Menu Item` checkbox is checked, the dashboard appears as a top-level item in the navigation bar. + If unchecked, it appears as a sub-item under `Dashboard` menu item. #. Import the dashboard by selecting the Create Dashboard button. diff --git a/Documentation/portal-guide/source/portal-user-guide/full-task-list/index.rst b/Documentation/portal-guide/source/portal-user-guide/full-task-list/index.rst index 904903174e2..ff6a9451208 100644 --- a/Documentation/portal-guide/source/portal-user-guide/full-task-list/index.rst +++ b/Documentation/portal-guide/source/portal-user-guide/full-task-list/index.rst @@ -3,8 +3,7 @@ Full Task List ************** -The **Full Task List** page shows you the tasks, as well as, advanced search and filter -capabilities. You can reach the page by using the |task-list-icon| :guilabel:`Tasks` +The **Full Task List** page is a dashboard featuring a single, full-width task widget. You can reach the page by using the |task-list-icon| :guilabel:`Tasks` link in the |ivy| Portal menu. .. note:: @@ -18,15 +17,7 @@ link in the |ivy| Portal menu. configuration of the |ivy| Portal, you might see not only the tasks belonging to you but - all open tasks. - - Visibility tasks assigned to roles depending on state: - - - Open: Visible for all members - - - In Progress: Visible for all members, but "parked" for working user (no actions possible for other role members) - - - Done: Visible for all members + all open tasks. |navigate-to-full-task-list-page| @@ -39,38 +30,42 @@ For each task the following key information is shown in the list: #. Priority -#. Name and Description +#. Task ID + +#. Name + +#. Description #. Responsible user or role -#. Task ID +#. State #. Creation Date #. Expiry Date -#. Status - #. Category -#. Application (This column is not displayed by default) - |task-key-information| -Furthermore, at the end of each row you find a side step menu of key features in +Furthermore, at the end of each row you find the `Actions` menu of key features in handling tasks: +#. Details + #. Reset Task #. Delegate Task #. Reserve -#. Destroy Task +#. Destroy + +#. Trigger Escalation -#. Trigger Escalation Task +#. Workflow Events -#. Add Ad-hoc Task +#. Process Viewer .. note:: @@ -80,7 +75,7 @@ handling tasks: :bdg-ref-warning:`🔑TaskDisplayWorkflowEventAction ` to allow a user to see the corresponding buttons and menu items. Finally, you have the possibility to access the full set of the task -data by clicking on the row containing the task Name and Description. +data by clicking on `Actions` then clicking on the `Details` menu item. The task details are separated into 4 different sections: @@ -105,110 +100,14 @@ The task details are separated into 4 different sections: |detailed-task-information| +HowTo: Configure the full task list +----------------------------------- -HowTo: Use existing filter --------------------------- +The full task list page functions as a dashboard accessible from the top-level menu. +To customize the task list, navigate to :ref:`Dashboard configuration `. -.. hint:: - If there are no public filters and you didn’t create any filters so far, - there might be no filters available. In this case, you must create a filter - first. This is described in detail in HowTo: Create new filter. - -#. Click on the :guilabel:`Save Filter` dropdown menu. - -#. Select the filter you want to use. - -HowTo: Create new filter ------------------------- - -#. Click on the button :guilabel:`More` to select one of the available filters. - For a list of available filters, see `Task filter`_. - -#. Click on the newly added filter and configure it. - -#. Add more filters by clicking on the button :guilabel:`Filter` again. - -#. Drop filters by clicking on the |delete-circle-icon| icon next to - the filter. - -#. When finished defining your filter, click on the button **Save - filter**. - -#. The :guilabel:`Save filter` dialog is opened. - -#. Under :guilabel:`Filter name`, provide a recognizable name for the filter. - -#. Under :guilabel:`Filter visibility`, you can select if the filter is only - visible for you or shall be available to all users. - -#. Save the filter by clicking the button :guilabel:`Ok`. - -|how-to-create-task-filter| - - -.. centered:: _`Task filter` - -+-----------------------------------+-----------------------------------+ -| Criteria | Description | -+===================================+===================================+ -| ID | The filter lets you specify the | -| | task identify number | -+-----------------------------------+-----------------------------------+ -| Name | The filter lets you specify the | -| | task name | -+-----------------------------------+-----------------------------------+ -| Completed on (from / to) | This filter lets you specify task | -| | complete period. | -+-----------------------------------+-----------------------------------+ -| Created (from / to) | This filter lets you specify in | -| | which time period the task was | -| | created. | -+-----------------------------------+-----------------------------------+ -| Description | This filter lets you search for | -| | keywords within the task | -| | description. | -+-----------------------------------+-----------------------------------+ -| Expiry (from / to) | This filter lets you specify in | -| | which time period the task will | -| | expire. | -+-----------------------------------+-----------------------------------+ -| Priority | This filter lets you specify the | -| | priority of the tasks to be | -| | shown. | -+-----------------------------------+-----------------------------------+ -| Responsible | This filter lets you specify a | -| | user or role which is responsible | -| | for the task. | -+-----------------------------------+-----------------------------------+ -| State | This filter lets you specify the | -| | task state. | -+-----------------------------------+-----------------------------------+ -| Category | This filter lets you specify | -| | the task category. | -+-----------------------------------+-----------------------------------+ -| Missing Activator | This filter is only for Admin and | -| | lets you find tasks which have no | -| | activator, activator is not found | -| | or is disabled. | -+-----------------------------------+-----------------------------------+ -| Application | This filter lets you select the | -| | application | -+-----------------------------------+-----------------------------------+ - - - -.. hint:: - #. You can create a new filter by selecting an existing filter, reconfiguring it, and saving it. - - #. Only users with the admin role ``AXONIVY_PORTAL_ADMIN`` can save the filter for all users. - -HowTo: Configure displayed tasks in the Full Task List -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -#. 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. +To restore the dashboard to its default settings, including the menu icon and task list layout, delete the dashboard. Portal will automatically +recreate the dashboard with the default settings. HowTo: Move and Resize Widgets in Task Details ---------------------------------------------- @@ -352,13 +251,11 @@ HowTo: Share Task Details .. |detailed-task-information-note| image:: ../../screenshots/task-detail/detailed-task-information-note.png .. |detailed-task-information-documents| image:: ../../screenshots/task-detail/detailed-task-information-documents.png .. |detailed-task-information| image:: ../../screenshots/task-detail/detailed-task-information.png -.. |how-to-create-task-filter| image:: ../../screenshots/task/how-to-create-task-filter.png .. |how-to-upload-document| image:: ../../screenshots/task-detail/how-to-upload-document.png .. |how-to-delete-document| image:: ../../screenshots/task-detail/how-to-delete-document.png .. |how-to-add-note| image:: ../../screenshots/task-detail/how-to-add-note.png .. |how-to-show-note-details| image:: ../../screenshots/task-detail/how-to-show-note-details.png .. |how-to-export-note-details| image:: ../../screenshots/task-detail/how-to-export-note-details.png -.. |how-to-show-workflow-event| image:: ../../screenshots/task-detail/how-to-show-workflow-event.png .. |workflow-events-table| image:: ../../screenshots/task-detail/workflow-events-table.png .. |export-to-excel-button| image:: ../../screenshots/task/export-to-excel-button.png .. |how-to-switch-to-view-mode| image:: ../../screenshots/task-detail/how-to-switch-to-view-mode.png