×

Please give details of the problem

Skip to content

List Widget

Allows you to define a list.

application_list

list-drop-down List

A list has the following properties fields :

  • Label : text written next to the list.
  • Label width : width of label (in pixel). It allows you to align vertically different widgets.
  • Label alignment : choose "Horizontal" to have the "Label" on the left of the widget and "Vertical" to have it on the top of the widget.
  • Value variable : name of the variable in the process to be filled in with selected item "Value". For "Users" list, it will be filled in with the email of the selected users. For "Entities or roles" list, it will be filled in with id of selected entity or role. For "Custom list" or "Variable based" list, it will be filled in with value of selected item. For "Uploaded files list" list, it will be filled in with id of selected file. For "Report", it will be filled up with configuration's URL of selected report.
  • Default variable value : default value of "value variable". It allows you to preselect an element in your list if check box initialize is checked
  • Label variable : name of the variable in the process to be filled in with selected item "Label". For "Users" list, it will be filled in with the name of the selected users. For "Entities or roles" list, it will be filled in with the name of selected entity or role. For "Custom list" or "Variable based" list, it will be filled in with label of selected item. For "Uploaded files list" list, it will be filled in with name of selected file. For "Report", it will be filled up with the name of the selected report.
  • Keep sorted : if you want your list to be displayed in an alphabetic order, check the box and choose "Sort type" : Ascending or Descending
  • Type : select the type of list to be displayed. 6 types are available :
    • Users : a list of "Users" for a given role or entity,
    • Entities or roles : a list of "Entities or roles" that belongs to a given father "Entity or role",
    • Custom list: a "Custom list" defined on RunMyProcess (see Custom list). Only custom lists defined in your web interface project (or a project included in your project) will be displayed
    • Uploaded files list : a list of "Uploaded files" with this web interface for a given process instance (see Upload file widget). It will allow user to download selected file.
    • Web interface report : a list of reports defined in Web interface report.
    • Process report : a list of reports defined in Process report.Only reports defined in your web interface project (or a project included in your project) will be proposed to user
    • Variable based : a list defined by a variable (field variable : name must be different from Label and Value variable) created in current web page with RunMyProcess javascript function called "setList" (see RunMyProcess javascript functions).
  • Choose an entity or a role button : this button only appears when "Type" of list is "Users" or "Entities or roles". It allows you to select one entity or one role of your organization. To select a role or an entity, click on the button, select a role or an entity and click on "OK" button.

info_3 If you need to select several roles or entities, or if you need to select a role or an entity dynamically (according to other field selection in this web page or to a variable of a process), you will need to use "List URL" field.

  • Choose a list button or New list button : these buttons only appear when "Type" of list is "Custom list". It allows you to create or select a predefined Custom list.

info_4 If you need to select a custom list dynamically (according to other fields selection in this web page or to a variable of a process), you will need to use "List URL" field.

  • Download : this field only appears when "Type" of list is "Uploaded files list". It allows you to define the name of the button that will allow user to download selected file.
  • List URL : this field only appears when "Type" of list is different from "Uploaded files list" or "Web interface report". It allows you to define a dynamic list.
    Example 1 : config/1/user?filter=LANE&operator=EE&value=3|5 gives you list of users that belongs to "Entity" or "Role" which Id are 3 and (intersection) 5
    Example 2 : config/1/user?filter=LANE&operator=IN&value=[[id_role2]]|[[id_role1]] gives you list of users that belongs to "Entity" or "Role" which Id are value of "id_role2" and (union) value of "id_role1".
    If "id_role1" and "id_role2" are variables defined in your Web page, you will have to fill up field "Listen to variables" with "id_role1,id_role2".
  • Picker : An option that let the users quickly find and select an item from a large list of Users, Entities or Roles as they type.
  • Picker property : the property that will be used to filter fetched data when the user starts typing.
  • new_1 Min input length : the number of characters necessary to start a search of users.
  • Multi-Selection : check this box if you want to allow users to perform multi-selection in the list (with shift or/and ctrl key). In this case, variables (value and label) will be array variables even if only one item is selected. Multi-selection is not possible for a drop down list (see Visible items field below).
  • Post loaded script : allows you to execute a script when list is completely loaded in web page. For instance : mylist=id_mylist.getList(); will create a "mylist" variable that will contains all items of your list with the same structure as a variable based list so that you can use all RMP javascript functions to manipulate it (mylist.getItemValueFromLabel('xxx')...).
  • Visible items : number of items to be displayed in the list (if you choose "1", you will have a drop down list).
  • Prompt : this field only appears if you have typed "1" in field "Visible items" (drop down list). It allows you to define text prompt of drop down list.
  • Tooltip : message to be displayed to the user when staying one or two seconds on the widget.
  • Listen to variables : name of the variables of the web page to listen to. When variable value changes, it will trigger the loading or the reloading of the list. This field must be filled when you define a "List URL" (dynamic url).
  • Identifier : id of the widget. You will only need it if you want to use Javascript functions in your web page.