catalog-ui/configurations/MenuReadMe.txt

   1 *******************************************************************
   2 *******             Explanation about menu.json             *******
   3 *******************************************************************
   4
   5 The menu.json defines the menu to show for each type of "roles":
   6
   7 Supported roles:
   8 -----------------------------
   9 ADMIN
  10 DESIGNER
  11
  12 The JSON is separated to roles, and for each role we define "states",
  13 what menu to show the user for each state of the component:
  14
  15 Supported states:
  16 -----------------------------
  17 NOT_CERTIFIED_CHECKOUT
  18 NOT_CERTIFIED_CHECKIN
  19 CERTIFIED
  20
  21 For each state we can define the user that will see this menu, the available parameters are:
  22
  23 Supported users:
  24 -----------------------------
  25 ANY
  26 NOT_OWNER
  27
  28 Example:
  29 For designer, if the component state is checkout and the component was created by other user, the NOT_OWNER will be used.
  30
  31 "DESIGNER":{
  32             "states":{
  33                 "NOT_CERTIFIED_CHECKOUT":{
  34                     "ANY":[
  35                         {"text":"Edit"    ,"action":"goToEntity"},
  36                         {"text":"Check in","action":"changeLifecycleState", "url":"lifecycleState/CHECKIN", "confirmationModal": "lifecycleState/CHECKIN"},
  37                         {"text":"View"    ,"action":"openViewerModal"}
  38                     ],
  39                     "NOT_OWNER":[
  40                         {"text":"View"    ,"action":"openViewerModal"}
  41                     ]
  42                 },
  43
  44
  45 Definition of the menu item:
  46 -----------------------------
  47 text                - The text to show
  48 action              - Function that will be called when pressing on the menu item
  49 url                 - Data added to menu item, in case the function need to use it, example: for function "changeLifecycleState", I need to pass also the url "lifecycleState/CHECKOUT" that I want the state to change to.
  50 confirmationModal   - Open confirmation modal (user should select "OK" or "Cancel"), and continue with the action.
  51 blockedForTypes     - This item will not be shown for specific components types.