Skip to content

Commit

Permalink
IVYPORTAL-17422 Remove Full Case List and Replace it with the Case Wi… (
Browse files Browse the repository at this point in the history 
#1237)

* IVYPORTAL-17422 Remove Full Case List and Replace it with the Case Widget
-  Update document for full task, case list

* IVYPORTAL-17422 Remove Full Case List and Replace it with the Case Widget
-  Update document for top level menu when configuring dashboard

* IVYPORTAL-17422 Remove Full Case List and Replace it with the Case Widget
-  Update document for dashboard configuration

* IVYPORTAL-17422 Remove Full Case List and Replace it with the Case Widget
-  Updated doc
  • Loading branch information
@lttung-axonivy
lttung-axonivy authored Nov 22, 2024
1 parent a72b8ce commit 4680a51
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 306 deletions.
17 changes: 5 additions & 12 deletions ...ion/portal-guide/source/portal-user-guide/admin-settings/documents/available_settings.csv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,16 @@ Portal.ApplicationName,"Axon Ivy",The default application name that will be disp
Portal.CaseDetails.HideDocument,FALSE,"Set to true, the document section in case detail page will be hidden, otherwise it will be shown."
Portal.CaseDetails.HideUploadDocumentForDoneCase,FALSE,Set to true to deny upload (also delete) document after a case is done.
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."
Portal.Cases.SortDirection,Sort descending,Default sort direction of case list.
Portal.Cases.SortField,Case Id,Default sort field of the case list.
| queries e.g. for case widget, global search."
Portal.Cases.HideCaseCreator,FALSE,"Set to true to hide case creator in case widget, case widget and case details. This setting affects all case queries, e.g. for case widget, global search."
Portal.Chat.EnableGroup,FALSE,Set this property to true to enable group chat function.
Portal.Chat.EnablePrivate,FALSE,Set this property to true to enable private chat function.
Portal.Chat.MaxConnection,3,"| The set number controls the amount of tabs allowed with active chat. If more tabs are opened,
| the chat will be disabled in inactive tabs. Allowed values are 1 to 5."
Portal.Chat.ResponseTimeout,0,"| Chat response timeout in seconds, default value is 0 and means no timeout. If chat messages go through
| the reverse proxy Nginx, chat response timeout must be less than the Nginx timeout, e.g. less than 60 seconds."
Portal.DateTimeFormat.DateFilterWithTime,FALSE,"Set to true to enable date filtering with time. This setting affects task list and case list."
Portal.DateTimeFormat.DateFilterWithTime,FALSE,"Set to true to enable date filtering with time. This setting affects task widget and case widget."
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.
Expand Down Expand Up @@ -42,12 +40,8 @@ Portal.ShowButtonIcon,TRUE,"If true, show icons in buttons."
Portal.ShowGlobalSearch,TRUE,"If true, display the global search box."
Portal.TaskDetails.HideDocument,FALSE,"If true, the document section in task detail page will be hidden, otherwise it will be shown."
Portal.TaskDetails.ShowDurationTime,TRUE,For switch on/off the display of the duration time in task details page.
Portal.Tasks.DisableCount,FALSE,Set to true to disable counting task in task list.
Portal.Tasks.RefreshInterval,10000,Task list refresh interval in seconds.
Portal.Tasks.SortDirection,Sort descending,Default sort direction of task list.
Portal.Tasks.SortField,Task Id,Default sort field of task list.
Portal.Tasks.BehaviourWhenClickingOnLineInTaskList,Run the task,"| Default behaviors (run the task or access task details) when clicking.
| on a line in the task list, task widget of the dashboard or on related tasks in the case details page."
| on a line in the task widget, task widget of the dashboard or on related tasks in the case details page."
Portal.UserMenu.HideChangePasswordMenu,FALSE,"Set this variable to true to hide the ""Change Password"" option in the top menu and the ""Forgotten Password"" option on the login page. If set to false, these options will be shown."
Portal.UserMenu.HideLogoutMenu,FALSE,"If true, the logout button on top menu will be hidden, otherwise it will be shown."
Portal.ProcessViewer,TRUE,"Set this property to true to display process viewer option in Task/Case actions. If a process is designed to not allow users to view it, the option in related Task/Case actions will be hidden."
Expand All @@ -71,5 +65,4 @@ Portal.UserMenu.ShowQRCode,FALSE,For switch on/off the display of the QR code.
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."
Portal.GlobalSearchScopeCategories,"PROCESSES,TASKS,CASES",Defining the types that the global search will search for.
9 changes: 6 additions & 3 deletions ...ntation/portal-guide/source/portal-user-guide/dashboard-configuration/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,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.

Expand Down Expand Up @@ -178,6 +180,8 @@ How to: import public dashboard
#. Drag and drop, or click on the :guilabel:`Upload one here` link to select the JSON file containing 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 :guilabel:`Create Dashboard` button.

Expand All @@ -202,6 +206,8 @@ A table of public dashboards is shown with the following information:

#. Dashboard description

#. Display as top menu or not

#. Actions: click on |actions-menu-icon| to get :guilabel:`Actions` menu for further actions: |edit-icon| Edit (name, description), |settings-icon| Configuration
(see: :ref:`Dashboards <new-dashboard>` ), |download-icon| Export dashboard, |share-icon| Share,
and |trash-icon| Delete a public dashboard.
Expand Down Expand Up @@ -233,9 +239,6 @@ You can rearrange dashboards by dragging and dropping |reorder-dashboard-icon| i

|reorder-public-dashboards|

.. hint::
- Note that this ordering does not apply to all users who ordered their dashboards. It is overridden by the personal ordering.

.. include:: ../includes/_common-icon.rst

.. |dashboard-configuration| image:: ../../screenshots/settings/dashboard-configuration.png
Expand Down
130 changes: 12 additions & 118 deletions Documentation/portal-guide/source/portal-user-guide/full-case-list/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,52 +3,40 @@
Full Case List
**************

The **Full Case List** page shows you all cases you are involved in.
This page provides you with extended information on the cases as well
as advanced search and filter capabilities. You can reach the page by
selecting |case-icon| :guilabel:`Cases` in the |ivy| Portal menu.
The **Full Case List** page is a dashboard featuring a single, full-width task widget.
You can reach the page by using the |case-icon| :guilabel:`Cases` link in the |ivy| Portal menu.

.. note::

Grant permission :bdg-ref-warning:`🔑AccessFullCaseList <AccessFullCaseList>` if |case-icon| :guilabel:`Cases` is not visible.

.. hint::
The set of cases you see in the Portal depends on the roles you hold
in both the application and the |ivy| Portal. Administrators
(having role AXONIVY_PORTAL_ADMIN) see all cases.
in in your applications.

|navigate-to-full-cases-list-page|

On the top of the **Full Case List** page, next to the heading
:guilabel:`Cases`, you see the overall number of cases shown to you, in
brackets. Below, you find the filter feature. Their usage will be explained below in
the HowTo’s section. Finally, you see the list of cases.

For each case, the list shows the following key information:

#. Name and Description

#. Case ID

#. Name

#. Description

#. Creator

#. Creation Date

#. Finished Date

#. Status
#. State

#. Category

#. Application (This column is not displayed by default)

|case-key-information|

At the end of each row you find a set of key features to handle cases:

#. Detail

#. :guilabel:`Actions` for further actions
At the end of each row you find a set of key features to handle cases by clicking on :guilabel:`Actions`.

To access the full set of case data, click on the case Name/Description.

Expand Down Expand Up @@ -78,94 +66,6 @@ The case details are separated into four different sections:

.. _howto-use-existing-filter-1:

HowTo: Use Existing Filter
--------------------------

.. 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 have to create a filter
first. This is described in detail in :ref:`howto-create-new-filter-1`.


#. Click on the :guilabel:`Save Filter` dropdown menu.

#. Select the filter you want to use.

.. _howto-create-new-filter-1:

HowTo: Create New Filter
------------------------

#. Click on :guilabel:`More` to select one of the available filters.
For a list of available filters, see Table 3: Case filter criteria.

#. Click on the newly added filter and configure it.

#. Add more filters by clicking on :guilabel:`More` again.

#. Drop filters by clicking on |delete-circle-icon| next to the filter.

#. When finished, click on :guilabel:`Save filter`.

#. The dialog :guilabel:`Save filter` is opened.

#. In :guilabel:`Filter name`, provide a descriptive name for the filter.

#. In :guilabel:`Filter visibility`, define if the filter is only
visible to you or to all users.

#. Save the filter by clicking :guilabel:`Ok`.

|how-to-create-case-filter|


.. centered:: Case filter criteria

+-----------------------+-----------------------------------+
| Criteria | Description |
+=======================+===================================+
| ID | Specify the ID of the case |
| | |
+-----------------------+-----------------------------------+
| Name | Specify the case name |
| | |
+-----------------------+-----------------------------------+
| Created (from / to) | Specify the period in which the |
| | case has been created. |
| | |
+-----------------------+-----------------------------------+
| Creator | Specify the user who has created |
| | the case. |
+-----------------------+-----------------------------------+
| Description | Search for keywords within the |
| | case description. |
| | |
+-----------------------+-----------------------------------+
| Finished (from / to) | Specify the period in which the |
| | case has been finished. |
+-----------------------+-----------------------------------+
| State | Specify the case state |
| | |
+-----------------------+-----------------------------------+
| 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 Cases in the Full Case List
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. To choose columns to display, click on :guilabel:`Manage columns`. Select
columns to display 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: Move and Resize Widgets in Case Details
----------------------------------------------
1. Open the case details
Expand Down Expand Up @@ -268,13 +168,6 @@ HowTo: Export a Case History

|export-case-history|

HowTo: Export Case List
-----------------------

To export the Case List, click on **Export to Excel**.

|export-to-excel-button|

HowTo: Manipulate Related Tasks Inside Case Details
---------------------------------------------------

Expand Down Expand Up @@ -312,6 +205,8 @@ following columns:

- Expiry Date

- Finished date

- State

At the end of each row, a side step menu is available. It offers the following
Expand All @@ -327,7 +222,7 @@ actions:

- Trigger Escalation Task

- Add Ad-hoc Task
- Workflow Events

To access the full set of the task data, click on the row containing the
task.
Expand Down Expand Up @@ -421,7 +316,6 @@ HowTo: Share Case Details
.. |how-to-add-task-note| image:: ../../screenshots/case-detail/how-to-add-task-note.png
.. |how-to-show-note-details| image:: ../../screenshots/case-detail/how-to-show-note-details.png
.. |export-case-history| image:: ../../screenshots/case/export-case-history.png
.. |export-to-excel-button| image:: ../../screenshots/case/export-to-excel-button.png
.. |how-to-switch-to-view-mode| image:: ../../screenshots/case-detail/how-to-switch-to-view-mode.png
.. |how-to-switch-to-edit-mode| image:: ../../screenshots/case-detail/how-to-switch-to-edit-mode.png
.. |how-to-reset-to-default| image:: ../../screenshots/case-detail/how-to-reset-to-default.png
Expand Down
Loading

0 comments on commit 4680a51

Please sign in to comment.