Difference between revisions of "Lister"
From All n One's bxp software Wixi
Philip Lacey (talk | contribs) |
|||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
| − | bxp gives every user | + | bxp gives every user the ability to create custom work lists for themselves and others. There is no limit to the number of listee's (work items) a user can have assigned to them. To start adding Listee's to the system, click on the ''View Reminders'' button located in the I Want To bar at the end of every page in your system. |
| Line 10: | Line 10: | ||
| − | 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. | + | After clicking on the above link, the user will be redirected to the standard bxp reminders page with one difference, they will now see the lister section at the top of the page. |
| Line 16: | Line 16: | ||
| − | + | This listee interface displays all of the listee's that they currently have, or the items that are assigned to them. Each listee displayed here will display the following information, provided the information is filled in. | |
| Line 27: | Line 27: | ||
| − | + | Here users can also add new listee's to the system by simply entering a ''title'' and ''category'' for the listee. This is the only information required to create a new listee. Further information can then be added to the listee using the notes area. | |
| − | Listee's can also be | + | Listee's can also be searched through by simply clicking on the ''Search My Listee's'' button. This allows users to search through all open or closed listee's that they have assigned to them. Administrators/System champions 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'' which a user can assign to themselves, i.e. Administrators will only ever see public listee's. |
== Adding/Updating Listee Notes == | == Adding/Updating Listee Notes == | ||
| − | When creating listee's | + | When creating listee's enter a title and a category. However, further expansion may be required on the listee. To add more information click on the ''Notes'' button located to the right hand side of each listee. |
| Line 40: | Line 40: | ||
| − | Once the above button is clicked a user will be redirected to the listee note section | + | Once the above button is clicked a user will be redirected to the listee note section. Here they will be able to add the following information to the listee: |
1) Title | 1) Title | ||
| Line 52: | Line 52: | ||
4) Is personal | 4) Is personal | ||
| − | * Flag the listee | + | * Flag the listee as personal or public |
5) Due Date | 5) Due Date | ||
| Line 58: | Line 58: | ||
6) Notes | 6) Notes | ||
| − | * | + | * Add an in depth description of the listee |
7) Deadline notes | 7) Deadline notes | ||
| Line 82: | Line 82: | ||
| − | '''[Note:''' An explanation of how to set up the four listee form links is | + | '''[Note:''' An explanation of how to set up the four listee form links is in the below section ''Lister Settings''''' ]''' |
[[File:lister_Notes_Main.png|border]] | [[File:lister_Notes_Main.png|border]] | ||
| Line 88: | Line 88: | ||
== Lister Settings == | == Lister Settings == | ||
| − | The Lister engine of bxp allows | + | The Lister engine of bxp allows administrators of the system to modify the Lister engine settings for each individual user in their instance of bxp. To do this simply navigate to the following system path:- |
| Line 97: | Line 97: | ||
''Main Menu > System Access Management > User Administration > Edit User - User Details'' | ''Main Menu > System Access Management > User Administration > Edit User - User Details'' | ||
| − | + | From here, lookup the user you wish to add/update the ''lister settings'' for. When you have found the desired user and have their user details, or security settings opened, scroll down to the section ''Lister & Jotter Options''. Here, there are six settings that you are able to modify: | |
| − | |||
| Line 119: | Line 118: | ||
=== Lister Options === | === Lister Options === | ||
| − | In this field you | + | In this field you can 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 - enable the administrator settings for the user. |
| − | To do this | + | To do this type the following into the ''Lister Options'' field --> True |
| Line 130: | Line 129: | ||
=== Lister Categories === | === Lister Categories === | ||
| − | In this field | + | In this field 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 will be the order they are displayed in the drop down list. |
| − | To enter categories to the users settings | + | To enter categories to the users settings type the following into the ''Lister Categories'' field --> Category 1, Category 2, Category 3, Category 4, Category 5 |
| Line 141: | Line 140: | ||
=== Lister Type 1 -> 4 === | === Lister Type 1 -> 4 === | ||
| − | The bxp Lister engine enables users to link listee's | + | The bxp Lister engine enables users to link listee's 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 | + | To enable linking to a form simply type the following into any of the "Lister Type" fields --> Form#123 |
| Line 151: | Line 150: | ||
== Searching Listee's == | == 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 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 administrative options enabled they will have the ability to search through all Listee's in the system whether or not they are complete, not complete, 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 | + | To search all listee's that are assigned to you, click on the ''Search My Listees'' button. If the lister administratove options are enabled for your user account click on ''Search All Listee's''. |
| Line 160: | Line 159: | ||
| − | When searching through your listee's you are able to uses many fields to perform a search | + | When searching through your listee's you are able to uses many fields to perform a search. The searchable fields are : |
1) Title | 1) Title | ||
| Line 177: | Line 176: | ||
| − | Once you have entered your search criteria | + | Once you have entered your search criteria click on the Search button at the bottom of the page. If you don't enter any search criteria and click the Search button, a list of all non-personal listee's in the system will be displayed. |
| Line 185: | Line 184: | ||
=== Listee Search Results === | === Listee Search Results === | ||
| − | After clicking on the ''Search'' button you will be presented with a list of all Listee's that matched the criteria | + | After clicking on the ''Search'' button you will be presented with a list of all Listee's that matched the criteria you entered. Once you have found the listee that you are looking for, 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|border]] | [[File:lister_Search_Select.png|border]] | ||
Revision as of 09:47, 30 March 2015
Contents
1 Overview
bxp gives every user the ability to create custom work lists for themselves and others. There is no limit to the number of listee's (work items) a user can have assigned to them. To start adding Listee's to the system, click on the View Reminders button located in the I Want To bar at the end of every page in your system.
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 now see the lister section at the top of the page.
This listee interface displays all of the listee's that they currently have, or the items that are assigned to them. Each listee displayed here will display the following information, provided the information is filled in.
- Id
- Title
- Links
- Due Date
- Category
- Function - Notes | Delete | Complete
Here users can also add new listee's to the system by simply entering a title and category for the listee. This is the only information required to create a new listee. Further information can then be added to the listee using the notes area.
Listee's can also be searched through by simply clicking on the Search My Listee's button. This allows users to search through all open or closed listee's that they have assigned to them. Administrators/System champions 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 which a user can assign to themselves, i.e. Administrators will only ever see public listee's.
3 Adding/Updating Listee Notes
When creating listee's enter a title and a category. However, further expansion may be required on the listee. To add more information click on the Notes button located to the right hand side of each listee.
Once the above button is clicked a user will be redirected to the listee note section. Here 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 as personal or public
5) Due Date
- The date the listee item is due to be completed
6) Notes
- Add 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 in the below section Lister Settings ]
4 Lister Settings
The Lister engine of bxp allows administrators of the system to modify the Lister engine settings for each individual user in their instance of bxp. To do this simply navigate to 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
From here, lookup the user you wish to add/update the lister settings for. When you have found the desired user and have their user details, or security settings opened, scroll down to the section Lister & Jotter Options. Here, 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
4.1 Lister Options
In this field you can 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 - enable the administrator settings for the user.
To do this type the following into the Lister Options field --> True
File:lister Settings options.png
4.2 Lister Categories
In this field 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 will be the order they are displayed in the drop down list.
To enter categories to the users settings 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 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
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 administrative options enabled they will have the ability to search through all Listee's in the system whether or not they are complete, not complete, 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, click on the Search My Listees button. If the lister administratove options are enabled for your user account click on Search All Listee's.
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 click on the Search button at the bottom of the page. If you don't enter any search criteria and click the Search button, a list of all non-personal listee's in the system will be displayed.
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 you entered. Once you have found the listee that you are looking for, 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.
