Version 8.1 by Petr Blšťák on 2020/04/30 05:32
Show last authors
1 (% class="box errormessage" %)
2 (((
3 This section is currently under construction... please wait until is finished
4 )))
5
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
15 = Introduction =
16
17 //On this page we use the term "Course" for both iTrivio courses and tests.//
18
19 The integration of Competent and iTrivio provides features from both softwares merged together and accessible through the Competent.
20
21 When specific objects are created in Competent, they are automatically created in iTrivio as well. Competent stores the ID references to the iTrivio objects in its database.
22
23 This applies to creation of:
24
25 * Users
26 * Courses (Activities with the specific launch type iTrivio)
27 * User-Course assignments
28 * User-Course attempts
29
30 iTrivio application is accessible only throught specific links in Competent when:
31
32 * editing a content of Course
33 * playing a Course
34 * displaying specific User-Course reports
35
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.
37
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
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 )))
44
45 The configuration below describes the basic scenario where
46
47 * both iTrivio and Competent are fresh installations
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.
50
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).
52
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.
62 1*. If you want new Users and Activities to be of default subtype, you dont need to create anything.
63 1*. If you want new Users and Activities to be of some special subtype
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
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
78 1. Go to **Administration **to the section **Users**
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.
80 1. Optionally you can create another new user that will be responsible only for creating new users in iTrivio
81 1. Go to the **Usergroups administration** and create new usergroup (for ecample Competent users) - this is where all your new users will be assigned.
82
83 === __Databases info__ ===
84
85 Now we need to write down IDs of all the objects we just created (and some more). If you have both systems fresh installations, you did not create any specific subtypes in Competent and users in iTrivio, you can just use the default values from brackets.
86
87 1. In __Competent__ database, in the table __subtype__ write down
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
90 1. In __Competent__ database, in the table __activity_set__ write down
91 1*. **ACTIVITY_FOLDER **(by default 1) = ID of the folder you created for new itrivio courses (find by name in the column "name")
92 1. In __iTrivio__ database, in the table __company__ write down
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")
95 1. In __iTrivio__ database, in the table __course__ write down
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")
97 1. In __iTrivio__ database, in the table __itrivio_user__ write down
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
101 1. In __iTrivio__ database, in the table __usergroup__ write down
102 1*. **USERGROUP **(by default 1) = ID of the usegroup that all your new users will be assigned to
103 1. In __iTrivio__ database, in the table __playerskintemplate__ write down
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)
105 1. IMPORTANT BUT CHECK WITH ONDREJ - manually connect the two admins in Competent DB by external ID???
106
107
108 = Configuration =
109
110 Now you can modify the systems configuration files, use the values written down from databases.
111
112 === __Competent__ ===
113
114 In the application.properties, or in your own application-yourNameShortcut.properties file set the following propeties:
115
116 {{code language="properties"}}
117 #-# set to true if enabled
118 competentItrivioIntegration.enabled=true
119
120 #-# itrivio company url context, leave empty if company has no url context
121 competentItrivioIntegration.itrivioCompanyUrlContext=<COMPANY_URL>
122
123 #-# url of iTrivio app (for integration API communication - accessible from Competent server location)
124 competentItrivioIntegration.url=http://localhost:8080/
125
126 #-# url of iTrivio app (for generating user links - accessible from browser of users)
127 competentItrivioIntegration.linkUrl=http://localhost:8080
128
129 #-# integrated iTrivio db company ID
130 competentItrivioIntegration.itrivioCompanyId=<COMPANY_ID>
131
132 #-# -------------- COMPETENT INTEGRATION ------------
133 #-# --- From Competent to iTrivio synchronization ---
134
135 #-# iTrivio db user ID, which will be used as a creator iTrivio ID when creating new users in iTrivio
136 competentItrivioIntegration.userCreatorItrivioUserId=<ADMIN_USER_CREATOR>
137
138 #-# iTrivio db user ID, which account will be used to perform actions in iTrivio (such as creating courses and users)
139 competentItrivioIntegration.auth.userId=<ADMIN_CREATOR>
140
141 #-# need to be same as "environment.id" property in iTrivio "settings.properties" file
142 competentItrivioIntegration.auth.environment=PROD
143
144 #-# need to be same as "jwt.key" property in iTrivio "settings.properties" file
145 competentItrivioIntegration.auth.key=CHANGE_ME
146
147 #-# -------------- COMPETENT INTEGRATION ------------
148 #-# --- From iTrivio to Competent synchronization ---
149
150 #-# competent db subtype ID, which will be used when creating new Users in Competent
151 competentItrivioIntegration.newUserSubtypeId=<USER_SUBTYPE>
152
153 #-# competent db subtype ID, which will be used when creating new Activities in Competent
154 competentItrivioIntegration.newActivitySubtypeId=<ACTIVITY_SUBTYPE>
155
156 #-# competent db activitySet (folder) ID, which will be used when creating new Activities in Competent as parent folder ID
157 competentItrivioIntegration.newActivityTargetFolderId=<ACTIVITY_FOLDER>
158 {{/code}}
159
160 = iTrivio part =
161
162 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.
163
164 Fill in the settings COMPETENT_INTEGRATION_XXX:
165
166 * **COMPETENT_INTEGRATION_ENABLED// //**//check the box to be set to true//
167 * **COMPETENT_INTEGRATION_TARGET_FOLDER_ID** = <COURSE_FOLDER>
168 * **COMPETENT_INTEGRATION_API_URL **//(url where Competent is running eg.: //[[http:~~/~~/localhost:9000/>>url:http://localhost:9000/]]//)//
169 * **COMPETENT_INTEGRATION_USERGROUP_ID** = <USERGROUP>
170 * **COMPETENT_INTEGRATION_COURSE_TEMPLATE** = <PLAYER_TEMPLATE>
171
172 Save the setting with the **Odeslat **button (nothing visible will happen, don't be worried, it was saved)
173
174 Now open the file "/com.itrivio/src/main/resources/settings.properties" and set the two following properties:
175
176 {{code language="properties"}}
177 # custom environment name, e.g. PROD,DEV,TEST... (must match the competentItrivioIntegration.auth.environment property from Competent)
178 environment.id=PROD
179
180 # secret part of you JWT key - used for communication with the Competent system and creating auto-login links
181 # see also jwt.expiration
182 # (must match the competentItrivioIntegration.auth.key property from Competent)
183 jwt.key=aaasssddd
184 {{/code}}
185
186 = Final setting test =
187
188 * Now run both Apps, **but do not touch iTrivio app** apart from making changes in the course creator tool when redirected there from Competent.
189 * Log into Competent, go to the Admin view to the Activities page.
190 * Create an Activity (of whatever subtype) and go to it's tab Details
191 * Edit the Launch type property, set it to iTrivio and hit the Save and Create in iTrivio button
192 * If you get any errors, check the configuration if all is set properly
193 * 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.
194 * Click the Start button, it should launch the iTrivio course for you.
195 * If all this works, everything is set correctly