Lister

Revision as of 10:56, 27 March 2015 by Patrick Jenkins (talk | contribs) (Searching Listee's)
Revision as of 10:56, 27 March 2015 by Patrick Jenkins (talk | contribs) (Searching Listee's)

Contents

1 Overview

bxp gives every user of the system the ability to create custom work lists for themselves and other bxp users. There is no limit to the amount of listee's (work items) a user can have assigned to them. To start adding Listee's to the system simply click on the View Reminders button located in the iwant-to bar at the end of every page in your system.


File:lister Button.png


2 Adding Listee's

After clicking on the above link, the user will be redirected to the standard bxp reminders page with one difference, they will see the lister section at the top of the page.


File:lister Main.png


From here users will see the lister interface, this shows them all of the listee's that they currently have or the ones that are assigned to them. Each listee that is displayed here will show the following information, if the info is filled in.


  • Id
  • Title
  • Links
  • Due Date
  • Category
  • Function - Notes | Delete | Complete


Users can also add new listee's to the system here to by simply entering in a title and category for the listee, that is the only information required to create a new listee more information can be then added to the listee through the notes area


Listee's can asp be search through from this page too by simply clicking on the Search My Listee's button, this allows users of the system to search through all open or closed listee's that they have assigned to them. Admin users of the bxp system have the ability to search through all listee's regardless if a listee is assigned to them or not, however all searches will exclude personal listee's a user has assigned to them. This is because a listee that a user has classified as personal may not relate to their job.


3 Adding/Updating Listee Notes

When creating listee's you only need a title and a category, but further expansion may be required on the listee. To do this simply click on the Notes button located to the right hand side of each listee.


Lister Notes.png


Once the above button is clicked a user will be redirected to the listee note section, her they will be able to add the following information to the listee:

1) Title

  • The title that you want the listee to have

2) Re-Assign (if admin)

  • The user the listee is currently assigned to

3) Complete status

  • Is the listee complete or still outstanding

4) Is personal

  • Flag the listee is personal or not

5) Due Date

  • The date the listee item is due to be completed

6) Notes

  • An in depth description of the listee

7) Deadline notes

  • Notes on the deadline i.e. notify certain people

8) Category

  • A category to classify the listee

9) Link 1

  • A record in a form the listee is linked to (Link 1)

10) Link 2

  • A record in a form the listee is linked to (Link 2)

11) Link 3

  • A record in a form the listee is linked to (Link 3)

12) Link 4

  • A record in a form the listee is linked to (Link 4)

13) eCourse Reference

  • A eCourse reference code the listee relates to


[Note: An explanation of how to set up the four listee form links is below in the section Lister Settings ]

File:lister Notes Main.png

4 Lister Settings

The Lister engine of bxp allows admins of the system to modify the Lister engine settings for each individual user in their instance of bxp. To do this simply navigate the following system path


Main Menu > System Access Management > User Administration > Edit User - Security Details

OR

Main Menu > System Access Management > User Administration > Edit User - User Details


Once here simply lookup the user you wish to add/update the lister settings for, when you have found the desired user and have there user details or user security settings opened, scroll down to the section Lister & Jotter Options. There are six settings that you are able to modify:


1) Lister Options

2) Lister Categories

3) Lister Type 1

4) Lister Type 2

5) Lister Type 3

6) Lister Type 4


File:lister Settings Main.png


4.1 Lister Options

In this field you are able to enable different options of the lister engine, this field takes a string separated with the # character between each option. Currently there is 1 option that can be enabled, that is to enable the administrator settings for the user.


To do this simply type the following into the Lister Options field --> True


File:lister Settings options.png


4.2 Lister Categories

In this field you are able to specify the category list for all Listee's the user has, this field takes a string separated with the , character between each option. There is no limit to the amount of categories you can specify, but note the order that they are entered in will be the order they are displayed in the drop down list.


To enter categories to the users settings simply type the following into the Lister Categories field --> Category 1, Category 2, Category 3, Category 4, Category 5


File:lister Settings Categories.png


4.3 Lister Type 1 -> 4

The bxp Lister engine enables users to link listee's off to four different records in four different (or the same) forms. Each one of the lister type fields takes a formatted string, this string needs to be formatted in the following way Form#Form Id. The Form tells the lister engine to link to a form, the Form Id tells the lister engine the form it is linking to.


To enable linking to a form simply type the following into any of the "Lister Type" fields --> Form#123


File:lister Settings Type.png

5 Searching Listee's

The bxp lister gives all users the ability to search thru all Listee's that are assigned to them whether they are complete or not. If the user has the admin option enabled they will have the ability to search through all Listee's in the system whether or not they are complete or not or even assigned to them, however any listee that is flagged as personal will not appear in the search results.

To search all listee's that are assigned to you simply click on the Search My Listees button. If the lister admin options are enabled for your user account simply click on the Search All Listees

File:lister Search Main.png

When searching through your listee's you are able to uses many fields to perform a search, the searchable fields are :

1) Title 2) Assigned to - If the admin settings are enabled for the user 3) Complete 4) Is Personal 5) Due Date 6) Notes 7) Deadline notes 8) Category 9) Link 1 10) Link 2 11) Link 3 12) Link 4 13) eCourse Ref

Once you have entered your search criteria simply click on the Search button at the bottom of the page. If you don't enter any search criteria and click the Search button, you will be displayed a list of all non-personal listee's in the system


File:lister Search Details.png


5.1 Listee Search Results

After clicking on the Search button you will be presented with a list of all Listee's that matched the criteria that you entered. Once you have found the listee that you are looking for, simply click on the blue button located to the left hand side of each Listee to be redirected to the notes page for the selected Listee


File:lister Search Select.png