Version 14.1 by Petr Blšťák on 2020/04/30 10:49
Hide last authors
admin admin 5.1 1 (% class="box errormessage" %)
2 (((
3 This section is currently under construction... please wait until is finished
4 )))
5
admin admin 2.1 6 = Software to be installed =
7
8 //Unless stated otherwise, newer stable versions of the program should work.//
9
10 ==== [[iTrivio 2.9.017>>doc:Main.Official manuals.iTrivio installation manual.WebHome]] ====
11
12 ==== [[Competent 33>>doc:Main.Official manuals.Competent installation manual.WebHome]] ====
13
14
admin admin 5.1 15 = Introduction =
16
Petr Blšťák 13.1 17 //On this page we use the term "Course" for both: course and test in iTrivio.//
admin admin 5.1 18
Petr Blšťák 12.1 19 The integration of Competent and iTrivio provides features from both softwares merged together and accessible through Competent.
admin admin 5.1 20
Petr Blšťák 13.1 21 When specific objects are created (and deleted) in Competent, they are automatically created (and deleted) in iTrivio as well. Competent stores the ID references to the iTrivio objects in it's database.
admin admin 5.1 22
Petr Blšťák 7.1 23 This applies to creation of:
admin admin 5.1 24
Ondřej Steffl 6.1 25 * Users
Petr Blšťák 7.1 26 * Courses (Activities with the specific launch type iTrivio)
Ondřej Steffl 6.1 27 * User-Course assignments
28 * User-Course attempts
admin admin 5.1 29
Petr Blšťák 7.1 30 iTrivio application is accessible only throught specific links in Competent when:
admin admin 5.1 31
Petr Blšťák 7.1 32 * editing a content of Course
33 * playing a Course
Ondřej Steffl 6.1 34 * displaying specific User-Course reports
admin admin 5.1 35
Petr Blšťák 7.1 36 The links to iTrivio contain a one time auto-login security token that approves the current user's action in iTrivio. There is no need for the user to log into iTrivio system manually.
admin admin 5.1 37
Petr Blšťák 7.1 38 By default the password of a user in iTrivio is different (random) from his password in Competent to prevent direct access to iTrivio. We recommend to disable iTrivio emailing and to keep iTrivio user's password secret to the user.
39
Ondřej Steffl 6.1 40 (% class="box warningmessage" %)
41 (((
42 **Modifying iTrivio directly (out of Competent platform) can cause synchronization issues, especially when manipulating with Users, Courses, User-Course attempts and assignments.**
43 )))
admin admin 2.1 44
Petr Blšťák 7.1 45 The configuration below describes the basic scenario where
admin admin 2.1 46
admin admin 5.1 47 * both iTrivio and Competent are fresh installations
Petr Blšťák 7.1 48 * login with the default iTrivio and Competent admin accounts were successfully tested
49 * Competent will be the main platform to handle course creation/deletion, user management and user-course management.
admin admin 2.1 50
Petr Blšťák 7.1 51 Contact Educasoft for specific configuration procedure in other, more complex scenarios (e.g. Competent is going to use existing iTrivio application already filled with course/user data).
Ondřej Steffl 3.1 52
Petr Blšťák 7.2 53 = Systems preparation =
54
55 In order for the two systems to work together, we first have to create the basic structures they will operate with - users, folders etc.
56
57 === __Competent__ ===
58
59 If you have both systems as a fresh installations and you will use them only throught the Competent system, you can skip this step and go to the iTrivio preparation.
60
61 1. We need to decide what subtypes we want to use for new Users and new Activites in the use case, when we would need to synchronize users and courses from iTrivio into Competent. This will not typically happen if you will use the systems as described above.
Petr Blšťák 14.1 62 1*. If you want new Users and Activities to be of default subtype, you don't need to create anything.
63 1*. If you want new Users and Activities to be of some other subtype
Petr Blšťák 7.2 64 1**. Log into Competent as the admin user
65 1**. switch to the Admin view
66 1**. go to the page Settings, to the tab Subtypes and create new subtypes for User and Activity (click on the green plus icon, fill in the new subtype name and hit the Create button).
67 1. Furthermore we need to create a folder, that would hold all the iTrivio courses in case of synchronization from iTrivio, so
68 1*. Log into Competent as the admin user and switch to the Admin view (if you didn't already)
69 1*. Go to the Competent page Activities and create a new folder named for example iTrivio Courses (click on the green plus icon, choose Folder, fill in it's name and click Save).
70
71 === __iTrivio__ ===
72
73 Here we need to create the users that will manipulate iTrivio courses and a folder to store them.
74
75 1. Log into iTrivio as admin user and go to the **Courses & Tests**
76 1. **Create a new folder** named for example Competent courses - this is where all your courses will be stored
Petr Blšťák 7.4 77 1. If you want the company default admin user to manage all the courses and users creation in iTrivio, skip to step 7), otherwise
Petr Blšťák 7.2 78 1. Go to **Administration **to the section **Users**
Petr Blšťák 7.4 79 1. **Create new user** that will be responsible for manipulating all objects in iTrivio (courses and users). Fill just his email, name and surename and assign him the role Administrator.
Petr Blšťák 7.2 80 1. Optionally you can create another new user that will be responsible only for creating new users in iTrivio
Petr Blšťák 14.1 81 1. Go to the **Usergroups administration** and create new usergroup (for example Competent users) - this is where all your new users will be assigned.
Petr Blšťák 7.2 82
Petr Blšťák 7.4 83 === __Databases info__ ===
Petr Blšťák 7.2 84
Petr Blšťák 14.1 85 Now we need to write down IDs of all the objects we just created (and some more). If you have both systems as fresh installations, you did not create any specific subtypes in Competent and users in iTrivio, you can just use the default values from brackets.
Petr Blšťák 7.2 86
Petr Blšťák 14.1 87 1. __Competent__ database, in the table __subtype__ write down
Petr Blšťák 7.2 88 1*. **USER_SUBTYPE **(by default 1) = subtype ID of the default_user (column "name") or if you created a specific subtype, find it by its name and write down it's ID
89 1*. **ACTIVITY_SUBTYPE **(by default 2) = subtype ID of the default_timeless_activity (column "name") that has "activity_type_id" = 1. If you created a specific subtype, find it by its name and write down it's ID
Petr Blšťák 14.1 90 1. __Competent__ database, in the table __activity_set__ write down
Petr Blšťák 7.4 91 1*. **ACTIVITY_FOLDER **(by default 1) = ID of the folder you created for new itrivio courses (find by name in the column "name")
Petr Blšťák 14.1 92 1. __iTrivio__ database, in the table __company__ write down
Petr Blšťák 7.4 93 1*. **COMPANY_ID **(by default 1) = ID of the company that will be synchornized with Competent (find by name in the column "name")
94 1*. **COMPANY_URL **(by default empty) = value from the column "urlContext" of the company that will be synchornized with Competent (find by name in the column "name")
Petr Blšťák 14.1 95 1. __iTrivio__ database, in the table __course__ write down
Petr Blšťák 7.4 96 1*. **COURSE_FOLDER **(by default 1) = ID of the folder that you created for new courses created from Competent (find by name in the column "name")
Petr Blšťák 14.1 97 1. __iTrivio__ database, in the table __itrivio_user__ write down
Petr Blšťák 7.4 98 1*. If you skipped the steps 4) - 6) in iTrivio preparation and you are using fresh iTrivio instalation, just write down the default values
99 1*. **ADMIN_CREATOR **(by default 2) = ID of the user that will be creating all the users and courses in iTrivio
100 1*. **ADMIN_USER_CREATOR **(by default 2) = ID of the user that will be creating all the users in iTrivio
Petr Blšťák 14.1 101 1. __iTrivio__ database, in the table __usergroup__ write down
Petr Blšťák 7.4 102 1*. **USERGROUP **(by default 1) = ID of the usegroup that all your new users will be assigned to
Petr Blšťák 14.1 103 1. __iTrivio__ database, in the table __playerskintemplate__ write down
Petr Blšťák 7.4 104 1*. **PLAYER_TEMPLATE **(by default 1) = ID of the player that will play your iTrivio courses (this is optional as the system has a default player)
Petr Blšťák 10.1 105 1. **TODO - IMPORTANT BUT CHECK WITH ONDREJ** - manually connect the two admins in Competent DB by external ID??? And generally who can EDIT the courses...?
Petr Blšťák 7.2 106
Petr Blšťák 7.4 107 = Configuration =
Ondřej Steffl 3.1 108
Petr Blšťák 7.5 109 Now you can modify the systems configuration files, use the values written down from databases.
110
Petr Blšťák 7.4 111 === __Competent__ ===
Ondřej Steffl 3.1 112
Petr Blšťák 7.4 113 In the application.properties, or in your own application-yourNameShortcut.properties file set the following propeties:
114
Petr Blšťák 7.5 115 {{code language="properties"}}
116 #-# set to true if enabled
117 competentItrivioIntegration.enabled=true
Ondřej Steffl 3.1 118
Petr Blšťák 7.5 119 #-# itrivio company url context, leave empty if company has no url context
120 competentItrivioIntegration.itrivioCompanyUrlContext=<COMPANY_URL>
121
122 #-# url of iTrivio app (for integration API communication - accessible from Competent server location)
123 competentItrivioIntegration.url=http://localhost:8080/
124
125 #-# url of iTrivio app (for generating user links - accessible from browser of users)
126 competentItrivioIntegration.linkUrl=http://localhost:8080
127
128 #-# integrated iTrivio db company ID
129 competentItrivioIntegration.itrivioCompanyId=<COMPANY_ID>
130
131 #-# -------------- COMPETENT INTEGRATION ------------
132 #-# --- From Competent to iTrivio synchronization ---
133
134 #-# iTrivio db user ID, which will be used as a creator iTrivio ID when creating new users in iTrivio
135 competentItrivioIntegration.userCreatorItrivioUserId=<ADMIN_USER_CREATOR>
136
137 #-# iTrivio db user ID, which account will be used to perform actions in iTrivio (such as creating courses and users)
138 competentItrivioIntegration.auth.userId=<ADMIN_CREATOR>
139
140 #-# need to be same as "environment.id" property in iTrivio "settings.properties" file
141 competentItrivioIntegration.auth.environment=PROD
142
143 #-# need to be same as "jwt.key" property in iTrivio "settings.properties" file
144 competentItrivioIntegration.auth.key=CHANGE_ME
145
146 #-# -------------- COMPETENT INTEGRATION ------------
147 #-# --- From iTrivio to Competent synchronization ---
148
149 #-# competent db subtype ID, which will be used when creating new Users in Competent
150 competentItrivioIntegration.newUserSubtypeId=<USER_SUBTYPE>
151
152 #-# competent db subtype ID, which will be used when creating new Activities in Competent
153 competentItrivioIntegration.newActivitySubtypeId=<ACTIVITY_SUBTYPE>
154
155 #-# competent db activitySet (folder) ID, which will be used when creating new Activities in Competent as parent folder ID
156 competentItrivioIntegration.newActivityTargetFolderId=<ACTIVITY_FOLDER>
157 {{/code}}
158
Ondřej Steffl 3.1 159 = iTrivio part =
160
Petr Blšťák 7.5 161 Run the url "http(s):~/~/<yourdomain>:<port>/(companyUrl/)setCompanyConfig.html" on the domain and port your iTrivio runs and with the companyUrl of the company you are setting this for.
Ondřej Steffl 3.1 162
Petr Blšťák 7.5 163 Fill in the settings COMPETENT_INTEGRATION_XXX:
Ondřej Steffl 3.1 164
Petr Blšťák 7.5 165 * **COMPETENT_INTEGRATION_ENABLED// //**//check the box to be set to true//
166 * **COMPETENT_INTEGRATION_TARGET_FOLDER_ID** = <COURSE_FOLDER>
167 * **COMPETENT_INTEGRATION_API_URL **//(url where Competent is running eg.: //[[http:~~/~~/localhost:9000/>>url:http://localhost:9000/]]//)//
168 * **COMPETENT_INTEGRATION_USERGROUP_ID** = <USERGROUP>
Petr Blšťák 9.1 169 * **COMPETENT_INTEGRATION_COURSE_TEMPLATE** = <PLAYER_TEMPLATE> TODO This doesn't seem to have any effect
Ondřej Steffl 3.1 170
Petr Blšťák 7.6 171 Save the setting with the **Odeslat **button (nothing visible will happen, don't be worried, it was saved)
Ondřej Steffl 3.1 172
Petr Blšťák 7.5 173 Now open the file "/com.itrivio/src/main/resources/settings.properties" and set the two following properties:
Ondřej Steffl 3.1 174
Petr Blšťák 7.5 175 {{code language="properties"}}
176 # custom environment name, e.g. PROD,DEV,TEST... (must match the competentItrivioIntegration.auth.environment property from Competent)
177 environment.id=PROD
Ondřej Steffl 3.1 178
Petr Blšťák 7.5 179 # secret part of you JWT key - used for communication with the Competent system and creating auto-login links
180 # see also jwt.expiration
181 # (must match the competentItrivioIntegration.auth.key property from Competent)
182 jwt.key=aaasssddd
183 {{/code}}
Ondřej Steffl 3.1 184
185 = Final setting test =
186
Petr Blšťák 7.6 187 * Now run both Apps, **but do not touch iTrivio app** apart from making changes in the course creator tool when redirected there from Competent.
188 * Log into Competent, go to the Admin view to the Activities page.
Petr Blšťák 7.7 189 * Create an Activity (of whatever subtype) and go to it's tab Details
190 * Edit the Launch type property, set it to iTrivio and hit the Save and Create in iTrivio button
191 * If you get any errors, check the configuration if all is set properly
Petr Blšťák 8.1 192 * Click the Edit button, it should take you to the iTrivio course editor, so add one new slide here, save it and close the browser tab.
193 * Click the Start button, it should launch the iTrivio course for you.
194 * If all this works, everything is set correctly