Last modified by bougault on 2022/03/02 11:58
From version 13.1
edited by allan
on 2019/11/26 17:07
Change comment: There is no comment for this version
To version 22.1
edited by allan
on 2020/02/26 14:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -8,7 +8,7 @@
8 8  
9 9  Send an email to [[support@humanbrainproject.eu>>mailto:support@humanbrainproject.eu]] with a short summary of your intentions.
10 10  
11 -The support team will apply the permissions to your user: your account will be upgraded with developers privileges the next time you will login.
11 +The support team will apply the permissions to your user: your account will be [[upgraded with developers privileges>>doc:Collabs.collab-devs.collaboratory-v2.keycloak.user administration.WebHome]] the next time you will login.
12 12  
13 13  (% class="box infomessage" %)
14 14  (((
... ... @@ -17,45 +17,70 @@
17 17  
18 18  == Making your app available to users ==
19 19  
20 -In order for you application to be installable by users, it needs to be registered within the [[Community Apps Catalogue>>doc:Apps.WebHome]].
20 +In order for you application to be installable by users, it needs to be registered within the [[Community Apps Catalogue>>doc:Apps.WebHome]].
21 21  
22 22  Once this simple step is complete, users will be able to install your app within their collabs.
23 23  
24 24  === Registering an application in the Catalogue ===
25 25  
26 -Navigate to the catalogue and click on **+Create App** in the top right corner. Enter a name for your app and click on **Create**.
26 +Navigate to the catalogue and click on **+Create App** in the top right corner. Enter a name for your app and click on **Create**.
27 27  
28 -Fill the form with the following information:
28 +Fill the form with the following information:
29 29  
30 -* **main URL**: the URL of the homepage of your app. This is where user will be directed when then open your app in a collab.
31 -* **settings URL**: the URL of the your settings management page if you have one.
32 -* **description**: a description of what your app does to help users select it.
33 -* **under development?**: should be checked if you don't want your app to be available by default by other users.
34 -* **category**: a category to help structuring the applications.
35 -* **maintainers**: a list of users who maintain the app. The users need to have logged in the wiki at least once to be found. Maintainers are granted the right to modify an app registration.
36 -* **documentation URL**: if your app has online user documentation, a link will be provided to users when they use your app.
37 -* **repository**: a URL to a public repository so users can check the sources of your app.
30 +* **main URL**: the URL of the homepage of your app. This is where user will be directed when then open your app in a collab.
31 +* **settings URL**: the URL of the your settings management page if you have one.
32 +* **description**: a description of what your app does to help users select it.
33 +* **under development?**: should be checked if you don't want your app to be available by default by other users.
34 +* **category**: a category to help structuring the applications.
35 +* **maintainers**: a list of users who maintain the app. The users need to have logged in the wiki at least once to be found. Maintainers are granted the right to modify an app registration.
36 +* **documentation URL**: if your app has online user documentation, a link will be provided to users when they use your app.
37 +* **repository**: a URL to a public repository so users can check the sources of your app.
38 38  
39 -Click on **Save**. Your app is now registered and waiting for users to install it!
39 +Click on **Save**. Your app is now registered and waiting for users to install it!
40 40  
41 -=== Installing your app in a collab ===
41 +=== Installing your app in a collab ===
42 42  
43 -1. In order to install your app, you need to navigate to a collab where you have either the **editor** or **administrator** role.
44 -1. Click on **Create**. Enter a title for this instance of your app and select **Community App** in the right selector.
45 -1. Click on **Create**. You will be presented with the Community App Catalogue. The app you will see are the public apps and the ones your a maintainer of.
46 -1. Select your app and click on **Save and View**.
43 +1. In order to install your app, you need to navigate to a collab where you have either the **editor** or **administrator** role.
44 +1. Click on **Create**. Enter a title for this instance of your app and select **Community App** in the right selector.
45 +1. Click on **Create**. You will be presented with the Community App Catalogue. The app you will see are the public apps and the ones your a maintainer of.
46 +1. Select your app and click on **Save and View**.
47 47  
48 -You should now see how your app looks like within a collab.
48 +You should now see how your app looks like within a collab.
49 49  
50 50  == Getting your app instance context ==
51 51  
52 52  Instances of your applications will be installed by collab authors in many different collabs. In order to let you customise the user experience based on its context, the Collaboratory will automatically pass query parameters to your app:
53 53  
54 -* **##clb-collab-id##**: the unique, human-readable identifier of the collab.
55 -* ##**clb-doc-path**##: the path of your app instance within the collab. If your app is at the root of a collab, this value will be empty.
56 -* ##**clb-doc-name**##: the name of the document where your app instance is installed.
57 -* ##**clb-drive-id**##: the unique identifier of the drive of the collab. This id is required if you want to fetch or store documents within the drive of the collab.
54 +* **##clb-collab-id##**: the unique, human-readable identifier of the collab.
55 +* ##**clb-doc-path**##: the path of your app instance within the collab. If your app is at the root of a collab, this value will be empty.
56 +* ##**clb-doc-name**##: the name of the document where your app instance is installed.
57 +* ##**clb-drive-id**##: the unique identifier of the drive of the collab. This id is required if you want to fetch or store documents within the drive of the collab.
58 58  
59 +== App settings ==
60 +
61 +The app settings are the values the collab author can modify to change the behaviour of your application within her collab.
62 +
63 +=== Writing settings ===
64 +
65 +The Collaboratory comes with a mechanism to let your app store these settings directly in the Collaboratory.
66 +
67 +In order to do that, your app needs to use the [[postMessage javascript API>>https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage]] to send the settings to store to the Collaboratory:
68 +
69 +{{code language="javascript"}}
70 +window.parent.postMessage({
71 + topic: '/clb/community-app/settings',
72 + data: {
73 + setting1: 'setting 1 value',
74 + setting2: 'setting 2 value',
75 + // ...
76 + // reload: false // avoid page reload on settings change
77 + }}, 'https://wiki.humanbrainproject.eu');
78 +{{/code}}
79 +
80 +=== Fetching settings ===
81 +
82 +The Collaboratory will get the settings from its key/value store and pass them to your app through query parameters.
83 +
59 59  == Creating your OpenID Connect client ==
60 60  
61 61  The steps to create an OpenID Connect client are the following:
... ... @@ -79,8 +79,8 @@
79 79  curl -X POST https://iam.humanbrainproject.eu/auth/realms/hbp/protocol/openid-connect/token \
80 80   -u developer: \
81 81   -d 'grant_type=password' \
82 - -d "username=${clb_dev_username}" \
83 - -d "password=${clb_dev_pwd}" |
107 + --data-urlencode "username=${clb_dev_username}" \
108 + --data-urlencode "password=${clb_dev_pwd}" |
84 84  
85 85  # Prettify the JSON response
86 86  json_pp;
... ... @@ -222,7 +222,5 @@
222 222   Note that your need to provide your client id both in the endpoint URL and within the body of the request.
223 223  
224 224  {{warning}}
225 -/!\ ** Each time you modify your client, a new registration access token will be generated. You need to track of your token changes to keep access to your client.   **/!\
250 +/!\ ** Each time you modify your client, a new registration access token will be generated. You need to track of your token changes to keep access to your client. **/!\
226 226  {{/warning}}
227 -
228 -== ==