Loading...
 
page id: 843 Profiles >  type >  Learning profile (to show off feature) Profiles >  type >  Available in the Profiles Wizard (12+) Profiles >  Tiki version >  21.x Profiles >  Tiki version >  24.x
Page actions
Print

Execute on List

trackers calculations plugin list plugin listexecute listexecute lists batch email mathematical calculation tracker field
Profile to demonstrate the usage of Plugin List Execute (to perform actions on several items from a list), among other features in Tiki 15 LTS and higher versions.

Image


These pages will be created:

YAML
preferences:
 feature_trackers: y
 feature_wiki_argvariable: y
 useGroupHome: y
 limitedGoGroupHome: y
 trackerfield_autoincrement: y
 trackerfield_dropdownother: y
 wikiplugin_remarksbox: y
 wikiplugin_tracker: y
 ajax_inline_edit: y
 feature_categories: y
 feature_fullscreen: y
 feature_jquery_tablesorter: y
 feature_multilingual: y
 feature_syntax_highlighter: y
 tracker_change_field_type: y
 trackerfield_itemslist: y
 trackerfield_math: y
 wikiplugin_list: y
 wikiplugin_listexecute: y
 wikiplugin_memberlist: y
 wikiplugin_tr: y
 wikiplugininline_div: y
 wikiplugininline_img: y
 instructions: Profile_Execute_Actions_instructions_page
objects: 
  - 
    type: tracker
    ref: trade_approval
    data: 
      name: Trade Approval
      description: >
        Keep record of trade requests, and
        approvals
      sort_default_order: desc
      list_default_status: opc
      modification_status: pending
      email: monitoring@example.com
      show: 
        - creation_date
        - modification_date
        - status
        - status_admin_only
  - 
    type: tracker_field
    ref: trade_approval_trAppID
    data: 
      name: ID
      permname: trAppID
      tracker: $profileobject:trade_approval$
      options: 
        start: 1
        itemId: itemId
      type: auto_increment
      order: 0
      flags: 
        - link
        - list
        - searchable
        - public
        - mandatory
  - 
    type: tracker_field
    ref: trade_approval_trAppEmail
    data: 
      name: Email
      permname: trAppEmail
      tracker: $profileobject:trade_approval$
      options: 
      type: email
      order: 10
      flags: 
        - list
        - searchable
        - public
        - mandatory
  - 
    type: tracker_field
    ref: trade_approval_trAppFullName
    data: 
      name: Full Name
      permname: trAppFullName
      tracker: $profileobject:trade_approval$
      options: 
        samerow: 1
        autocomplete: n
        exact: n
      type: text_field
      order: 20
      flags: 
        - list
        - searchable
        - public
        - mandatory
  - 
    type: tracker_field
    ref: trade_approval_trAppAcceptTerms
    data: 
      name: Accept terms
      permname: trAppAcceptTerms
      tracker: $profileobject:trade_approval$
      options: 
      type: checkbox
      order: 50
      flags: 
        - public
        - mandatory
  - 
    type: tracker_field
    ref: trade_approval_trAppLastReviewerUserName
    data: 
      name: Last Reviewer
      permname: trAppLastReviewerUserName
      tracker: $profileobject:trade_approval$
      options: 
        autoassign: 2
        groupIds: 
          - 0
        canChangeGroupIds: 
          - 0
      type: user
      order: 60
      flags: 
        - searchable
        - public
  - 
    type: tracker_field
    ref: trade_approval_trAppGCPreApprovalDate
    data: 
      name: GC Pre-Approval Date
      permname: trAppGCPreApprovalDate
      tracker: $profileobject:trade_approval$
      options: 
      type: calendar
      order: 70
      description: General Counsel Pre-Approval Date
      flags: 
        - list
        - searchable
        - public
  - 
    type: tracker_field
    ref: trade_approval_trAppCEOPreApprovalDate
    data: 
      name: CEO Pre-Approval Date
      permname: trAppCEOPreApprovalDate
      tracker: $profileobject:trade_approval$
      options: 
      type: calendar
      order: 80
      flags: 
        - list
        - searchable
        - public
  - 
    type: tracker_field
    ref: trade_approval_trAppYouCanTradeUntil
    data: 
      name: You can trade until...
      permname: trAppYouCanTradeUntil
      tracker: $profileobject:trade_approval$
      options: 
        datetime: dt
      type: calendar
      order: 90
      flags: 
        - list
        - searchable
        - public
  - 
    type: tracker_field
    ref: trade_approval_trAppTradingPeriodEndDate
    data: 
      name: Trading Period End Date
      permname: trAppTradingPeriodEndDate
      tracker: $profileobject:trade_approval$
      options: 
        samerow: 1
        autocomplete: n
        exact: n
      type: text_field
      order: 100
      flags: 
        - list
        - searchable
        - public
  - 
    type: tracker_field
    ref: trade_approval_trAppApprovalStatus
    data: 
      name: Approval Status
      permname: trAppApprovalStatus
      tracker: $profileobject:trade_approval$
      options: 
        parentId: $profileobject:categ_approval_status$
        inputtype: d
        recategorize: save
      type: category
      order: 110
      flags: 
        - list
        - searchable
        - public
  - 
    type: tracker_field
    ref: trade_approval_trAppApprovalDate
    data: 
      name: Approval Date
      permname: trAppApprovalDate
      tracker: $profileobject:trade_approval$
      options: 
        calculation: |
          (if (IsEmpty (and trAppGCPreApprovalDate trAppCEOPreApprovalDate)) "-"
          (if (more-than trAppGCPreApprovalDate trAppCEOPreApprovalDate) (date  (str Y-m-d H:i) trAppGCPreApprovalDate) (date  (str Y-m-d H:i) trAppCEOPreApprovalDate) ) )
        recalculate: index
      type: math
      order: 120
      flags: 
        - list
        - searchable
        - public
  - 
    type: tracker_option
    ref: trade_approval_sort_default_field
    data: 
      tracker: $profileobject:trade_approval$
      name: sort_default_field
      value: modification


Categories

YAML
objects:
 -
  type: category
  ref: categ_approval_status
  data:
   name: Approval Status
   description: Base category used to manage custom status labels on the requests
 -
  type: category
  ref: category_approved
  data:
   name: Approved
   parent: $categ_approval_status
 -
  type: category
  ref: category_denied
  data:
   name: Denied
   parent: $categ_approval_status
 -
  type: category
  ref: category_postponed
  data:
   name: Postponed
   parent: $categ_approval_status



Groups

Create a group "group1" which has permission to cast a vote in the Voting system. The other group "group2" can't add items to that tracker (therefore, its members can't vote).

YAML
permissions:
 Gc:
  home:  $profileobject:listexecute_homepage_gc$
  description: Homepage for the General Counsel (GC)
  allow:
   - create_tracker_items
   - list_trackers
   - view_trackers
  include: [ Registered ]
  objects:
   -
    type: tracker
    id: $profileobject:trade_approval$
    allow:
     - create_tracker_items
     - list_trackers
     - view_trackers
 Ceo:
  home:  $profileobject:listexecute_homepage_ceo$
  description: Homepage for the Chief Executive Officer (CEO)
  allow:
   - create_tracker_items
   - list_trackers
   - view_trackers
  include: [ Registered ]
  objects:
   -
    type: tracker
    id: $profileobject:trade_approval$
    deny:
     - create_tracker_items
     - list_trackers
     - view_trackers
 Staff:
  home:  $profileobject:listexecute_homepage_staff$
  description: Homepage for Staff members of the Company
  allow:
   - create_tracker_items
   - list_trackers
   - view_trackers
  include: [ Registered ]
  objects:
   -
    type: tracker
    id: $profileobject:trade_approval$
    allow:
     - create_tracker_items
     - list_trackers
     - view_trackers



Users

Add a user to the group Members
YAML
objects:
 -
  type: user
  data: 
    name: gc
    pass: 12345
    email: gc@example.com
    change: n
    groups: [ Gc ]
 -
  type: user
  data: 
    name: ceo
    pass: 12345
    email: ceo@example.com
    change: n
    groups: [ Ceo ]
 -
  type: user
  data: 
    name: staff1
    pass: 12345
    email: staff1@example.com
    change: n
    groups: [ Staff ]
 -
  type: user
  data: 
    name: staff2
    pass: 12345
    email: staff2@example.com
    change: n
    groups: [ Staff ]


1.1. Permissions (YAML)


YAML
permissions:
 Anonymous:
  allow:
   - list_trackers
   - search
   - tracker_view_comments
   - view
   - view_category
   - view_freetags
   - view_trackers
   - view_trackers_pending
  objects:
   -
    type: wiki_page
    id: Profile_Execute_Actions_tpl_own
    allow: [ view, use_as_template ]
    deny: [  ]
   -
    type: wiki_page
    id: Profile_Execute_Actions_tpl_new
    allow: [ view, use_as_template ]
    deny: [  ]
 Registered:
  allow:
   - comment
   - comment_tracker_items
   - create_tracker_items
   - add_object
   - remove_object
   - edit
   - edit_categorized
   - freetags_tag
   - post_comments
   - tracker_vote_ratings
   - watch_trackers



Modules

YAML
objects: 
 - 
  type: module
  ref: module_menupage_listexecute
  data: 
   name: menupage
   params: 
    pagemenu: $listexecute_menupage_include
   groups: 
    - Anonymous
    - Registered
   order: 1
   position: left


Sample vote from user1


YAML
objects:
 -
  type: tracker_item
  ref: vote_001
  data:
   tracker: $trade_approval
   status:
   values:
    - [ $trade_approval_trAppID, 1 ]
    - [ $trade_approval_trAppEmail, armando.bronca@example.com ]
    - [ $trade_approval_trAppFullName, Armando Bronca PhD. ]
    - [ $trade_approval_trAppAcceptTerms, yes ]
    - [ $trade_approval_trAppLastReviewerUserName, admin ]
    - [ $trade_approval_trAppGCPreApprovalDate,  null]
    - [ $trade_approval_trAppCEOPreApprovalDate, D(-2 hours) ]
    - [ $trade_approval_trAppYouCanTradeUntil, D(+2 day) ]
    - [ $trade_approval_trAppTradingPeriodEndDate, D(+3 day) ]
    - [ $trade_approval_trAppApprovalStatus, null]
    - [ $trade_approval_trAppApprovalDate, null]


Wiki pages

Add instructions, menu and a form to add requests


This will include: Profile_Execute_Actions_insert_request_page

YAML
instructions: Instructions of the Execute on List profile
preferences:
  enable: [ feature_wiki ]
objects:
  -
    type: wiki_page
    ref:  instructions_listexecute_page
    data:
      name: Instructions of the Execute on List profile
      description: The System to Execute Actions on Listed Items
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_Execute_Actions_instructions_page
  -
    type: wiki_page
    ref:  listexecute_menupage_include
    data:
      name: Menu from Execute on List
      description: Menu with links for the common actions in the Execute Actions on Listed Items
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_Execute_Actions_menupage_include
  -
    type: wiki_page
    ref:  insert_request_page
    data:
      name: Form to insert requests
      description: The System to add new requests to the system
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_Execute_Actions_insert_request_page
  -
    type: wiki_page
    ref:  insert_request_email_tpl_own_page
    data:
      name: tpl_report_own_request
      description: Template in wiki page for the notification emails sent to the own requester with the tracker item insertion
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_Execute_Actions_tpl_own
  -
    type: wiki_page
    ref:  insert_request_email_tpl_new_page
    data:
      name: tpl_report_new_request
      description: Template in wiki page for the notification emails sent to the reviewer with the tracker item insertion
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_Execute_Actions_tpl_new


Add a page homepage for users Gc, Ceo, and Staff1 & Staff2


This will include: Profile_Execute_Actions_gc_homepage_page

YAML
preferences:
  enable: [ feature_wiki ]
objects:
  -
    type: wiki_page
    ref:  listexecute_homepage_gc
    data:
      name: Homepage for user Gc
      description: Review the requests and add y our pre-approval
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_Execute_Actions_Homepage_Gc
  -
    type: wiki_page
    ref:  listexecute_homepage_ceo
    data:
      name: Homepage for user CEO
      description: Review the requests and add y our pre-approval
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_Execute_Actions_Homepage_Ceo
  -
    type: wiki_page
    ref:  listexecute_homepage_staff
    data:
      name: Homepage for Staff Users
      description: Review the requests and manage them
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_Execute_Actions_Homepage_Staff
  -
    type: wiki_page
    ref:  listexecute_homepage_admins
    data:
      name: Homepage for Admins
      description: Review the requests and users
      lang: en
      mode: create_or_update
      content: wikicontent:Profile_Execute_Actions_Homepage_Admins





Category: Learning profile (to show off feature)
Category: Available in the Profiles Wizard (12+)
Category: 21.x
Category: 24.x
History Comments