Last modified by Petr Blšťák on 2024/09/18 11:55
From version < 7.1 >
edited by Petr Blšťák
on 2020/04/30 02:37
To version < 7.5 >
edited by Petr Blšťák
on 2020/04/30 04:46
< >
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -50,55 +50,137 @@
50 50  
51 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 52  
53 -= Competent part =
53 += Systems preparation =
54 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.
55 55  
56 -in application.properties, or in your own application-yourNameShortcut.properties file set the following propeties:
57 +=== __Competent__ ===
57 57  
58 -* **competentItrivioIntegration.enabled=true**
59 -//(true to allow the connection between apps)//
60 -* **competentItrivioIntegration.itrivioCompanyUrlContext=/test**
61 -//(url name of the company for which you are setting the connection, leave empty if the only company is the root)//
62 -* **competentItrivioIntegration.url=http:~/~/localhost:8080/**
63 -//(url of the iTrivio app)//
64 -* **competentItrivioIntegration.linkUrl=http:~/~/127.0.0.1:8080**
65 -//(probably the same as above, this will be the url where the iTrivio courses will run, leave out the final slash! or the course address will show wrong)//
66 -* **competentItrivioIntegration.itrivioCompanyId=1**
67 -//(Id of the company you are setting it for)//
68 -* **competentItrivioIntegration.userCreatorItrivioUserId=2**
69 -//(ID of the user - existing in the system - in whos name the courses will be created. Someone with Admin roles)//
70 -* **competentItrivioIntegration.newUserSubtypeId=1**
71 -//(ID of subtype of user in Competent? - for when creating new users - probably)//
72 -* **competentItrivioIntegration.newActivitySubtypeId=2**
73 -//(ID of subtype of Activity? - when creating new activities - probably)//
74 -* **competentItrivioIntegration.newActivityTargetFolderId=20**
75 -//(ID of folder in iTrivio in which to create new Activites)//
76 -* **competentItrivioIntegration.auth.userId=2**
77 -//(ID of user in whose name the authorisation of running the course will be done?)//
78 -* **competentItrivioIntegration.auth.key=**
79 -//(secret key for JWT token)//
80 -* **competentItrivioIntegration.auth.environment=demo**
81 -//(authentication environment, used in JWT token I think)//
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.
82 82  
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 +
106 +
107 += Configuration =
108 +
109 +Now you can modify the systems configuration files, use the values written down from databases.
110 +
111 +=== __Competent__ ===
112 +
113 +In the application.properties, or in your own application-yourNameShortcut.properties file set the following propeties:
114 +
115 +{{code language="properties"}}
116 +#-# set to true if enabled
117 +competentItrivioIntegration.enabled=true
118 +
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 +
83 83  = iTrivio part =
84 84  
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.
85 85  
86 -Run the url [[http:~~/~~/localhost:8080/(companyUrl/)setCompanyConfig.html>>url:http://localhost:8080/setCompanyConfig.html?locale=cs]] of course on the domain your iTrivio runs and with the companyUrl of the comany you are setting this for.
163 +Fill in the settings COMPETENT_INTEGRATION_XXX:
87 87  
88 -Fill in the settings COMPETENT_INTEGRATION_:
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>
169 +* **COMPETENT_INTEGRATION_COURSE_TEMPLATE** = <PLAYER_TEMPLATE>
89 89  
90 -* **COMPETENT_INTEGRATION_ENABLED**// (set to true)//
91 -* **COMPETENT_INTEGRATION_TARGET_FOLDER_ID **//(ID of folder in iTrivio in which to create new Activites)//
92 -* **COMPETENT_INTEGRATION_API_URL **//(url where competent is running eg.: //[[http:~~/~~/localhost:9000/>>url:http://localhost:9000/]]//)//
93 -* **COMPETENT_INTEGRATION_USERGROUP_ID **//(ID of usergroup in iTrivio in which new users will be created)//
94 -* **COMPETENT_INTEGRATION_COURSE_TEMPLATE **//(optional - ID of course template in which new courses will be created)//
171 +Save the setting with the **Odeslat **button
95 95  
96 -//(Save the settings... )//
173 +Now open the file "/com.itrivio/src/main/resources/settings.properties" and set the two following properties:
97 97  
98 -Now open the file /com.itrivio/src/main/resources/settings.properties and set the two following properties:
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
99 99  
100 -**environment.id=croco**// (must match the **competentItrivioIntegration.auth.environment** property from Competent)//
101 -**jwt.key=CCzzzQYDR1HTdfe67zoa **//(must match the **competentItrivioIntegration.auth.key** property from Competent)//
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}}
102 102  
103 103  = Final setting test =
104 104