Case Study: Adding Proper Activity Names to Domains

Domains configured to track Activity-related data have, in their natural state, an "Activity Name" field. However, this field simply names the basic form of Activity ("Quiz," for example). 

This case study will cover the process of adding a derived table that allows you to include the proper name of the activity ("User Management Quiz," for example).

For the purposes of this case study, we will add a Derived Table to the Activity Completion Domain. 

This Derived Table is not natively included with this Domain, as you will require a select statement for each Activity you intend to track—but we will make this as smooth as possible.

To begin, you will need to copy the Activity Completion Domain from the Public folder into your private organizational folder tree. To copy the Activity Completion Domain, complete the following steps:

1. In the Repository, navigate to Public > Moodle/Totara > Domains.
2. Right-click the Activity Completion Domain and select Copy.
3. Navigate to the folder in your private organizational tree where you would like to copy the Domain.
4. Right-click the folder and select Paste.
   
   

Now that you have an editable copy of the Activity Completion Domain, you can edit it to add the Derived Table. BEFORE YOU OPEN THE DOMAIN DESIGNER, ENSURE YOU HAVE NOTED THE FOLLOWING THINGS FOR YOUR LMS ACTIVITIES

To add the Derived Table to your newly copied Activity Completion Domain, complete the following steps:

1. Right-click the Activity Completion Domain and select Edit. The Edit Domain page opens. 
2. Underneath the Domain Design heading, click the Edit withDomain Designer link. The Domain Designer opens to the Display tab.
3. Navigate to the Derived Tables tab.
4. In the Query ID field, enter the name "proper_act_name".

5. In the Query field, you will need to enter a series of select statements based on the following formula:
   
   

   select m.id as moduleid, m.name as moduletype, t.id as instanceid, t.name as instancename, t.course as courseid from /*LMS TABLE*/ t join mdl_modules m on m.name = '/*NAME*/'
   union

   
   Note the two variables highlighted in this select statement:

   •  /*LMS TABLE*/ : In place of this variable, insert the proper LMS module table name. For example, 'mdl_lesson' or 'mdl_quiz'.

   • /*NAME*/ : In place of this variable, insert the name of the Activity. For example, 'lesson' or 'quiz'.

6. To start, you can begin by entering the following sample Derived Table. You will likely find this series of select statements to miss some of your custom modules and name several that you do not use. Enter the following query into the Query field:
   
   

   select m.id as moduleid, m.name as moduletype, t.id as instanceid, t.name as instancename, t.course as courseid from mdl_assign t join mdl_modules m on m.name = 'assign'
   union
   select m.id as moduleid, m.name as moduletype, t.id as instanceid, t.name as instancename, t.course as courseid from mdl_assignment t join mdl_modules m on m.name = 'assignment'
   union
   select m.id as moduleid, m.name as moduletype, t.id as instanceid, t.name as instancename, t.course as courseid from mdl_book t join mdl_modules m on m.name = 'book'
   union
   select m.id as moduleid, m.name as moduletype, t.id as instanceid, t.name as instancename, t.course as courseid from mdl_chat t join mdl_modules m on m.name = 'chat'
   union
   select m.id as moduleid, m.name as moduletype, t.id as instanceid, t.name as instancename, t.course as courseid from mdl_choice t join mdl_modules m on m.name = 'choice'
   union
   select m.id as moduleid, m.name as moduletype, t.id as instanceid, t.name as instancename, t.course as courseid from mdl_data t join mdl_modules m on m.name = 'data'

7. Click Run Query. 
8. If there are tables referenced in this query that do not exist in your LMS, you will receive an error similar to that shown in the following image:
   
    
   
   If you receive this error, simply remove the offending statement from the query and run it again. 
9. If your query runs successfully, you will need to select from the returned results. Select the entire list by holding Command/Shift/CTRL and selecting each field:
   
    
10. Click Save Table. Your new Derived Table will appear in the Available Objects panel with the unique Derived Table / Calculated Field identifier.
11. Navigate to the Joins tab and create the following joins:
    1. 1. 1. From the Left Table, select the course field from the mdl_course_modules table, then from the Right Table select the courseid field from the proper_act_name Derived Table. Click the Left Outer Join button.
          2. From the Left Table, select the module field from the mdl_course_modules table, then from the Right Table select the moduleid field from the proper_act_name Derived Table. Click the Left Outer Join button. 
          3. A modal window appears, notifying you that the tables have already been joined, and that a composite key will be created. Click the OK button to complete your second join: 
             
             
          4. From the Left Table, select the instance field from the mdl_course_modules table, then from the Right Table select the instanceid field from the proper_act_name Derived Table. Click the Left Outer Join button.
          5. Click the OK button in the modal window that appears.
12. Navigate to the Display tab.
13. In the Resources panel, select to View as: Join Tree.
14. Expand JoinTree_1, then expand the  table:
    
    
15. Select the instanceid field and drag it into the Activity Completions set in the Sets and Items panel.
16. In the Sets and Items panel, select the newly added instanceid item.
17. In the Properties panel, click the Edit button. The property fields of the instanceid item become editable.
18. In the Label field, rename the instance item to "Proper Activity Name", for presentation purposes.
19. Click the Save button to save your changes to the Proper Activity Name item.
20. Click the OK button to save your changes in the Domain Designer and return to the Edit Domain page.
21. Under the Required Information heading, rename the Activity Completions Domain in the Name field, in order to avoid confusing it with the Public Activity Completions Domain. We will call this Domain the "Activity Completions Domain - Proper Names".
22. To save your changes to the Domain, click the Submit button.