From wiki.ginstr.com
Jump to: navigation, search
Line 5: Line 5:
 
==General==
 
==General==
  
In SSO server the following roles are defined, with ascending order for access level:
+
In SSO server the following <span id="SSO_roles">roles</span> are defined, with ascending order for access level:
  
*USER
+
*<code>USER</code>
*ADMIN
+
*<code>ADMIN</code>
*MASTER
+
*<code>MASTER</code>
*SUPERVISOR
+
*<code>SUPERVISOR</code>
  
"Standard" users  (i.e. registered via signup form) have role USER, which allows them to perform actions on themselves and their subaccounts only. ADMINISTRATOR, MASTER and SUPERVISOR are special users with increased permissions.<br>
+
"Standard" users  (i.e. registered via [[sso_common_content#Signing_up_for_new_SSO_account|sign up form]]) have role <code>USER</code>, which allows them to perform actions on themselves and their [[sso_common_content#subaccounts|subaccounts]] only.
  
 +
<code>ADMIN</code>, <code>MASTER</code> and <code>SUPERVISOR</code> are special user roles with increased permissions.
 +
[[File:supervisor_menu.png|thumb|211px|additional options in <code>SUPERVISOR</code> menu]]
 +
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
 +
|-
 +
! action !! class="unsortable" | <code>SUPERVISOR</code> role !! class="unsortable" | <code>MASTER</code> role !! class="unsortable" | <code>ADMIN</code> role !! class="unsortable" | <code>USER</code> role
 +
|-
 +
| delete || can delete all users || can delete <code>ADMIN</code> & <code>USER</code> users only || can delete <code>USER</code> users only|| cannot delete users
 +
|-
 +
| see || can see all users || can see <code>ADMIN</code> & <code>USER</code> users only|| can see <code>USER</code> users only|| can see himself and subusers only
 +
|-
 +
| modify || can modify all users || can modify <code>ADMIN</code> & <code>USER</code> users only|| can modify <code>USER</code> users only|| can modify himself and subusers only
 +
|-
 +
| add || can add all users || can add <code>ADMIN</code> & <code>USER</code> users only|| can add <code>USER</code> users only|| can modify himself and subusers only
 +
|-
 +
| update || can update all users || cannot update users || cannot update users || cannot update users
 +
|}
  
Legend:
+
These roles are distinct from the roles defined in [[sso_common_content#roles|SSO Common Content roles section]] which are user-created roles for permissions on ginstr apps tables while SSO roles relate to permissions for SSO users.
  
U = USER<br>
+
When a user with <code>SUPERVISOR</code> permission logs in to SSO, the following additional options appear in the [[sso_common_content#SSO_lobby_menu|SSO lobby menu]] (accessed by hovering mouse over user name in top right corner of screen when logged in to SSO).
A = ADMIN<br>
 
M = MASTER<br>
 
S = SUPERVISOR<br>
 
 
 
 
 
S can delete all, M can delete A and U users, A can delete U users, U cannot delete<br>
 
S can see all, M can see A and U users, A can see U users, U can see himself and subusers<br>
 
S can see all, M can see A and U users, A can see U users, U can see himself and subusers<br>
 
S can modify all, M can modify A and U users, A can modify U users, U can modify himself and subusers<br>
 
S can add all, M can add A and U users, A can add U users, U cannot add<br>
 
S can see all, M can see A and U users, A can see U users, U cannot see<br>
 
S can update all, M, A, U cannot update<br>
 
S can see all, A can see all, M, U cannot see<br>
 
 
 
 
 
This roles should be distinct from roles defined in SSO Common Content section of wiki which relate to user created roles for permissions on ginstr apps tables while SSO roles relate to permissions for SSO users.
 
 
 
 
 
When user with SUPERVISOR permission log in to SSO additional options appear in menu in top right corner:
 
  
 
*edit users
 
*edit users
Line 42: Line 39:
 
*configure applications
 
*configure applications
  
When users with ADMINISTRATOR or MASTER role log in to SSO they get only additional "edit users" option in menu in top right corner
+
When users with <code>ADMIN</code> or <code>MASTER</code> role log in to SSO, only the additional option ''''edit users'''' appears in the [[sso_common_content#SSO_lobby_menu|SSO lobby menu]].
 
 
 
 
 
 
[[File:supervisor_menu.png|thumb|250px|none|additional options in SUPERVISOR menu]]
 
 
 
  
 
==edit users==
 
==edit users==
 
+
[[File:list_of_users.png|thumb|700px|''''list of users'''' table]]
 
In this section are listed all SSO users with options to create new users, edit users, delete users and enable/disable ginstr for certain user.  
 
In this section are listed all SSO users with options to create new users, edit users, delete users and enable/disable ginstr for certain user.  
  
 +
This list of users is divided in multiple columns containing different info related to users. The table can be sorted by each of these columns by clicking on the sort icon[[File:sort.gif]]located at the top right of each column heading.
  
[[File:list_of_users.png|thumb|250px|none|list of users]]
+
;DB num: this column contains id of user which is generated by SSO server automatically. Each id is a unique identifier for each user.
 
+
;main account: this column is only filled if the user is a subaccount user, in which case it displays the main account of subaccount user
This list of users is divided in multiple columns containing different info related to users. Table can be sorted by each of this columns.<br>Columns which need additional explanation are DB num, main account, account status and max subs.
+
;<span id="account_status">account status</span>: existing account statuses are:
 
+
:*<code>ACTIVE</code>
'''DB num''' - in this column is displayed id of user which is generated by SSO server automatically. This is unique identifier for each user. <br>
+
:*<code>SUSPENDED</code> (if for example user tried log in with incorrect password several times)
'''main account''' - this column have value only if user is subaccount user. In this column is displayed main account of subaccount user<br>
+
:*<code>DELETED</code> (if account is no longer in use it can be assigned <code>DELETED</code> status and will be completely removed after several days)
'''account status''' - existing account statuses are ACTIVE, SUSPENDED (if for example user tried log in with incorrect password for several times), DELETED (if account is no longer in use it can be set to have DELETED status and will be completely removed after several days), UNCONFIRMED (this is status which have every new user until activate account by click on activation link in e-mail send after registration)<br>
+
:*<code>UNCONFIRMED</code> (assigned to every new user until their account is [[sso_common_content#Activation|activated by clicking on the activation link in e-mail sent after registration]])
'''max subs''' - in this column is displayed maximal number of subaccounts which user can create. This number is defined by SUPERVISOR/ADMIN/MASTER when creating new user or editing existing user on edit user page or it is defined by ginstr subscription bought in ginstr shop on ginstr web site.
+
;max subs: this column displays maximum number of [[sso_common_content#subaccounts|subaccounts]] which user can create.
 
+
:This number is defined by <code>SUPERVISOR</code>/<code>ADMIN</code>/<code>MASTER</code> when creating new user or [[#edit|editing existing user]] on '''[[#edit_users|edit users]]''' page or by [https://shop.ginstr.com/produkt-kategorie/subscriptions/ ginstr subscription] purchased from the [https://shop.ginstr.com/ ginstr shop].
On far right side of page there are several links which when clicked open new pages or make some status changes on user accounts. This links are:
 
  
*edit
+
On the far right side of page there are several links which when clicked open new pages or make some status changes on user accounts:-
*remove
+
*[[#edit|edit]]
*EULA decisions
+
*[[#remove|remove]]
*enable ginstr/disable ginstr
+
*[[#EULA_decisions|EULA decisions]]
*reset ginstr
+
*[[#enable_ginstr/disable_ginstr|enable ginstr/disable ginstr]]
 +
*[[#reset ginstr|reset ginstr]]
  
 +
----
  
 
===edit===
 
===edit===
  
 +
This page is the same as the page for creating new user which is opened by clicking on the <div style="display:inline-block;width:120px;height:auto;text-align:center;padding:0px 4px;vertical-align:middle;-moz-border-radius:3px;-webkit-border-radius:3px;border-radius:3px;background-color:#66d9ff"><span style="color:#404040;font-size:88%;font-weight:bold">new user</span></div> button at the bottom of the ''''list of users'''' page.
 +
[[File:edit_user_data.png|thumb|500px|user's general information]]
 +
At the top left side there are fields with general information related to the selected user account.
  
On this page there are different sections and will describe each section separately. This page is same as page for creating new user which is opened when click on "new user" button on list of users page.<br>
+
:;e-mail: In this field you can enter a personal or company e-mail address for the selected user.
 
+
:;password and re-enter password: These two fields are used to change the current password for the selected user.
 +
:;NFC: In this field you can enter an [[NFC#NFC_Tags|NFC tag]] id, allowing the selected user to log in to ginstr apps by scanning this [[NFC#NFC_Tags|NFC tag]] on Android devices with built-in [[NFC]] technology.
 +
:;first name and last name: In these fields you can modify first and last name which were entered on account creation.
 +
:;mobile number: In this field you can enter a personal or company mobile number for the selected user.
 +
:;company (optional): In this field you can enter the name of the selected user's company.
  
On top left side there are fields with general info related to user account. Same data exists on sign up page on SSO log in page when user registers new account.
+
[[File:attachments_limits.png|thumb|500px|attachments upload disable / enable and setting attachments limit section]]
[[File:edit_user_data.png|thumb|250px|none|user's general information]]
+
At the bottom left side there is a section where <code>SUPERVISOR</code>/<code>ADMIN</code>/<code>MASTER</code> can set restrictions on attachments uploaded by the selected user.
  
 +
:;disable chat support: This checkbox disables [[sso_common_content#ginstr_Support_Chat|support chat]] so that the chat window will no longer be displayed to the selected user in either SSO or [[ginstr web]].
 +
:;enable upload of videos: if checked, the selected user can upload video files to [[ginstr web]].
 +
:;max. size per video in MB: defines the maximum size permitted for each video file uploaded by selected user.
 +
:;max. size all videos in MB: defines the maximum total size permitted for all video files uploaded by the selected user.
 +
:;enable upload of pictures: if checked, the selected user can upload image files to [[ginstr web]].
 +
:;max. size per picture in MB: defines the maximum size permitted for each image file uploaded by the selected user.
 +
:;max. size all pictures in MB: defines the maximum total size permitted for all image files uploaded by the selected user.
 +
:;enable upload of voice notes: if checked, selected user can upload audio files to [[ginstr web]].
 +
:;max. size per voice note in MB: defines the maximum size permitted for each audio file uploaded by the selected user.
 +
:;max. size all voice notes in MB: defines the maximum total size permitted for all audio files uploaded by the selected user.
 +
:;enable upload of documents: if checked, the selected user can upload document files to [[ginstr web]].
 +
:;max. size per document in MB: defines the maximum size permitted for each document file uploaded by selected user.
 +
:;max. total size of all documents in MB: defines the maximum total size permitted for all document files uploaded by the selected user.
 +
:;max. size account in MB: defines the maximum total size permitted for all files uploaded by the selected user.
  
 +
[[File:user_settings.png|thumb|500px|user settings]]
 +
In the top right corner there is a section related to the selected user account settings.
  
In bottom left side there is section where SUPERVISOR/ADMIN/MASTER can set if uploading of attachments (pictures, videos, audio files and documents) is allowed for that account and if allowed then to set limit for each attachment type and total files limit. Limits are defined in MB. In this section there is also checkbox to disable support chat for that account in SSO and ginstr web.
+
:;comment about user: This field can be used to save some comment(s) related to the selected user account.
[[File:attachments_limits.png|thumb|250px|none|attachments upload disable / enable and setting attachments limit section]]
+
:;account status: This drop down menu can be used to change the [[#account_status|status]] of account (<code>ACTIVE</code>/<code>SUSPENDED</code>/<code>DELETED</code>)
 +
:;role: This drop down menu can be used to change the [[#SSO_roles|SSO role]] of the selected account (<code>USER</code>/<code>ADMIN</code>/<code>MASTER</code>/<code>SUPERVISOR</code>)
 +
:;enforce password expiry policy?: If checked, the selected user will be forced to renew password after certain period of time
 +
:;ignore password and username minimum requirements for this account?: If checked, the default password requirements (password must have one number, one uppercase letter, one lowercase letter and at least eight characters) will not be disregarded on next renewal or change of password by the selected user
 +
:;language: This drop down menu can be used to change the language in which SSO content will be displayed for the selected user
 +
:;number of booked subaccounts: In this field you can define the maximum number of [[sso_common_content#subaccounts|subaccounts]] which the selected user can create.
 +
::This field is not displayed if editing a [[sso_common_content#subaccounts|subaccount]].
 +
::Once this amount is set here manually, it is no longer set by a user's [https://shop.ginstr.com/produkt-kategorie/subscriptions/ ginstr subscription], and can only be changed by a user with <code>SUPERVISOR</code>/<code>ADMIN</code>/<code>MASTER</code> role (unless a [[#reset_ginstr|reset]] is performed).
 +
:;account was created by: This field, which is only shown if the selected user is a subaccount, displays the name of the main account which created the subaccount.
  
 +
[[File:edit_applications_section.png|thumb|250px|section for editing user's applications]]
 +
[[File:edit_max_rows.png|thumb|250px|dialog for defining maximum amount of rows in each table of the selected app]]
 +
[[File:demo_data_dialog.png|thumb|250px|dialog for generating demo data of PLUS applications]]
 +
In the bottom right corner there is a list of all existing applications where <code>SUPERVISOR</code>/<code>ADMIN</code>/<code>MASTER</code> can enable/disable each app for the selected user, remove tables and data of certain apps for that user, set maximum amount of rows that can be added in table of some app and generate demo data for PLUS applications.
  
 +
On top of this section there are 3 links :-
 +
:;activate all: enables all applications in list below
 +
:;deactivate all: disables all applications in list below
 +
:;remove all tables: removes all tables and data from enabled applications in list below
  
In top right corner there is section related to settings of user account.
+
Below these links is a list of modules (which are displayed in SSO lobby) and ginstr apps (which are displayed in the [[sso_common_content#hide.2Fshow_content|hide/show content section]] of the [[sso_common_content#my_account|my account page]] on every main user account).
[[File:user_settings.png|thumb|250px|none|user settings]]
 
Here can be added some comment related to user in "comment about user" field.<br>
 
In account status drop down menu can be changed status of account (active, suspended, deleted)<br>
 
In role drop down can be changed SSO role of that account (user, master, administrator, supervisor)<br>
 
By checking "enforce password expiry policy?" checkbox user will be forced to renew password after certain period of time<br>
 
By checking "ignore password and username minimum requirements for this account?" rule that password must have one number, one uppercase letter, one lowercase letter and at least eight characters will not be respected on next renewal or change of password by user.<br>
 
In language drop down can be changed language in which SSO content will be displayed for that user.<br>
 
In "number of booked subaccounts" field can be entered amount of subaccounts which that main user can create. This field does not exist if edit subaccount. Once this amount set here manually then ginstr shop does not control subscription anymore but it is controlled by SUPERVISOR/ADMIN/MASTER<br>
 
Additional item that appear in this section if editing subaccount is "account was created by" where is displayed name of main account which created that subaccount.
 
  
In bottom right corner there is list of all existing applications where SUPERVISOR/ADMIN/MASTER can enable/disable some app for account, remove tables and data of certain app for that user, set maximal amount of rows that can be added in table of some app and generate demo data for PLUS applications.
+
Before each module and application name there is a checkbox which can be used to manually activate / deactivate each separate module and application.
[[File:edit_applications_section.png|thumb|250px|none|section for editing user's applications]]
 
On top of this section there are 3 links activate all, deactivate all, remove all tables.<br> Click on activate all link enables all applications in list below.<br> Click on deactivate all link disables all applications in list below. <br>Click on remove all tables removes all tables and data from enabled applications in list below.<br>
 
In top part of application list are listed modules which are displayed in SSO lobby and after this modules are displayed ginstr apps which are displayed in hide/show content section of my account page on every main user account. <br>
 
Before each module and application name there is checkbox that enables to manually activate / deactivate each separate module and application<br>
 
After each ginstr application name there is trash can icon which when clicked opens dialog with security question. If SUPERVISOR/ADMIN/MASTER choose yes in dialog then all tables and data of that app for user which is currently edited will be removed.<br>
 
If tables of some ginstr app are already generated for account which is edited then after name of that application will be present pencil icon. Clicking on that icon will open dialog where can be set maximal amount of rows in each table of that application.
 
[[File:edit_max_rows.png|thumb|250px|none|dialog for defining maximal amount of rows]]
 
In this dialog it can be defined for each app's table what should be maximal amount of rows that can be added to that table by user. If user try to add more then set amount then appropriate error will be displayed to user. If values in fields in this dialog are empty this means that unlimited amount of rows can be added to table.<br>If Application is removed for some user amounts of rows which are set as limit will be preserved and applied again if application is enabled for that user again. <br>
 
For PLUS applications there is additional arrow icon. Click on that icon opens dialog where can be chosen language and predefined demo data for that language will be generated for that PLUS app on user account which is edited.
 
[[File:demo_data_dialog.png|thumb|250px|none|dialog for generating demo data of PLUS applications]]
 
  
 +
After each ginstr application name, one or more of the following icons will be displayed :-
  
 +
:;[[File:delete_icon.png]] delete icon: The delete icon appears after every ginstr application name, and when clicked opens a ''''delete'''' dialog window with a security question.
 +
::If a <code>SUPERVISOR</code>/<code>ADMIN</code>/<code>MASTER</code> chooses ''''yes'''' in the security dialog then all tables and data of the selected app belonging to the selected user will be removed.
 +
:;[[File:pencil_icon.png]] pencil icon: If tables of a ginstr app are already generated for the selected user, there will also be a pencil icon next to the application name.
 +
::Clicking on the pencil icon will open a dialog window to set the maximum amount of rows in each table of the selected app.
 +
::In this dialog window you can define the maximum amount of rows that can be added to each app table by user.
 +
::If the user attempts to add more rows than the maximum amount defined here, they will be shown an error message.
 +
::If no value is entered in a field, this means that an unlimited amount of rows can be added to table.
 +
::The limits applied here are saved when disabling an app for the selected user and are applied again if application is subsequently enabled for that user again.
 +
:;[[File:arrow_icon.png]] arrow icon: For PLUS applications there is an additional arrow icon.
 +
::Clicking on the arrow icon opens a dialog window for applying the predefined demo data for the language selected in the drop down to the PLUS app on the selected user account.
  
 +
----
  
 
===remove===
 
===remove===
  
Click on this link will set that account status to DELETED. After several days account and all of its data will be completely removed.
+
Clicking the '''remove''' button on the ''''list of users'''' table sets the selected account status to <code>DELETED</code>.
 
 
  
 +
After several days account and all of its data will be completely removed.
  
 
===EULA decisions===
 
===EULA decisions===
 +
[[File:EULA_decisions.png|thumb|250px|'''EULA decisions''' page]]
 +
Clicking the '''EULA decisions''' button on the ''''list of users'''' table opens a dialog box which contains a record of when the EULA (End User License Agreement) was accepted or declined by the selected user.
  
When click on this link that new page will open with table which contains information if EULA (End User License Agreement) was accepted or declined by that user, for which apps at what time and from which IP address.
+
===enable ginstr/disable ginstr===
[[File:EULA_decisions.png|thumb|250px|none|EULA decisions page]]
 
  
 +
Disabling ginstr for a certain account means that the selected user will not be able to use the ginstr module at all.
  
 +
Upon the expiry of a [https://shop.ginstr.com/produkt-kategorie/subscriptions/ ginstr subscription], ginstr is automatically disabled for that account.
  
===enable ginstr/disable ginstr===
+
The '''enable ginstr/disable ginstr''' links in the ''''list of users'''' table allows a <code>SUPERVISOR</code>/<code>ADMIN</code>/<code>MASTER</code> to manually enable/disable ginstr for some accounts.
  
If ginstr is disabled for certain account that means that user will not be able to use ginstr module at all. Enabling / disabling of ginstr is actually controlled by shop on ginstr web site in a way that if user bought subscription for certain amount of subaccounts once user activate account via link in e-mail then account will be activated with that number of booked subaccounts and with enabled ginstr for main account and all subaccount which will that main account create. After subscription expire ginstr becomes disabled. enable ginstr/disable ginstr links in list of users table are introduced so that SUPERVISOR/ADMIN/MASTER can manually enable/disable ginstr for some accounts. In case ginstr is enabled/disabled manually then ginstr shop lose control over that account and all further actions in this regard on that account must be performed manually by SUPERVISOR/ADMIN/MASTER.
+
In case ginstr is enabled/disabled manually then [https://shop.ginstr.com/ ginstr shop] no longer has control over that account and all further actions in this regard on that account must be performed manually by a <code>SUPERVISOR</code>/<code>ADMIN</code>/<code>MASTER</code> (unless a [[#reset_ginstr|reset]] is performed).
  
 +
===reset ginstr===
  
 +
Clicking on '''reset ginstr''' link for some account returns control of the account to [https://shop.ginstr.com/ ginstr shop] and all changes previously made manually by <code>SUPERVISOR</code>/<code>ADMIN</code>/<code>MASTER</code> are overridden.
  
===reset ginstr===
+
==configure lobby==
 +
[[File:configure_lobby.png|thumb|250px|'''configure lobby''' page]]
 +
In this section a <code>SUPERVISOR</code> can configure modules which are displayed in [[sso_common_content#SSO_lobby|SSO server lobby]].
  
When click on reset ginstr link for some account then control over that account is returned to ginstr shop and all changes previously made manually by SUPERVISOR/ADMIN/MASTER are overridden.
+
For each module, the following modifications can be made:
 +
*name of module that will be displayed in [[sso_common_content#SSO_lobby|SSO lobby]]
 +
*link to module address
 +
*icon which will be displayed in [[sso_common_content#SSO_lobby|SSO lobby]] for that module
 +
*whether module should be displayed for all users by default in [[sso_common_content#SSO_lobby|SSO lobby]]
  
 +
==configure applications==
 +
[[File:configure_applications.png|thumb|500px|'''configure application''' page]]
 +
On this page a <code>SUPERVISOR</code> can edit existing ginstr applications or add a new ginstr application to server.
  
 +
The ''''configure applications'''' table contains the following columns :-
 +
*App ID
 +
*Display Name
 +
*owner of private application
 +
*Active By Default
 +
*App version
 +
*Minimum ginstr launcher version
 +
*App Icon
 +
*Uploaded by
 +
*Uploaded on date
  
==configure lobby==
+
===new application page===
 +
[[File:new_app_screen.png|thumb|500px|'''new application''' page]]
 +
When a <code>SUPERVISOR</code> clicks on the <div style="display:inline-block;width:120px;height:auto;text-align:center;padding:0px 4px;vertical-align:middle;-moz-border-radius:3px;-webkit-border-radius:3px;border-radius:3px;background-color:#66d9ff"><span style="color:#404040;font-size:88%;font-weight:bold">new application</span></div> button, a new page is opened with the following fields:-
  
 +
:;type: This drop down contains two options - '''private''' or '''public'''
 +
::A '''private''' application is published only for a certain user and is visible only for that certain user and no one else.
 +
::A '''public''' application can be active by default or not active by default. If a '''public''' app is active by default then it will be displayed for all existing and future accounts. If a '''public''' app is not active by default it will be displayed only for those accounts where a <code>SUPERVISOR</code> enables that app.
 +
:;owner of private application: If '''private''' is chosen from the '''type''' field, this drop down is used to select the username of user who will be able to use that application
 +
:;Display Name: This field is used to enter the name of the new app which will be displayed in SSO and in [[ginstr web]].
 +
:;Active by Default: This checkbox is not editable for '''private''' applications because such application is visible only for user chosen in owner of private application drop down.
 +
::For a '''public''' app, enabling this checkbox means that the new app will be displayed for all existing and future accounts.
 +
:;App ID: This field is for the unique identifier of the new app and must be entered for both '''private''' and '''public''' app. App ID must be in [https://en.wikipedia.org/wiki/Camel_case camel case] and be same as the name of the application zip file.
  
In this section SUPERVISOR can configure modules which are displayed in SSO server lobby.
+
*After all required fields are filled, click on the <div style="display:inline-block;width:80px;height:auto;text-align:center;padding:0px 4px;vertical-align:middle;-moz-border-radius:3px;-webkit-border-radius:3px;border-radius:3px;background-color:silver"><span style="color:#404040;font-size:88%;font-weight:bold">Browse...</span></div> button to select the new application .zip file from your local PC.
[[File:configure_lobby.png|thumb|250px|none|configure lobby screen]]
 
  
Here SUPERVISOR can configure name of module that will be displayed in SSO lobby, link to module address, choose one of icons which will be displayed in SSO lobby for that module and select if module should be displayed for all users by default in SSO lobby
+
*Once file is selected, click on the <div style="display:inline-block;width:120px;height:auto;text-align:center;padding:0px 4px;vertical-align:middle;-moz-border-radius:3px;-webkit-border-radius:3px;border-radius:3px;background-color:#66d9ff"><span style="color:#404040;font-size:88%;font-weight:bold">save</span></div> button to start the upload process.
  
 +
*Upload progress is displayed in bar below the <div style="display:inline-block;width:80px;height:auto;text-align:center;padding:0px 4px;vertical-align:middle;-moz-border-radius:3px;-webkit-border-radius:3px;border-radius:3px;background-color:silver"><span style="color:#404040;font-size:88%;font-weight:bold">Browse...</span></div> button.
  
==configure applications==
+
*When upload is complete, a success message (with green background) confirms that the app has been added to the server and is now displayed in the '''[[#configure_applications|configure applications]]''' page. If there was a problem during upload then an error message (with red background) will be displayed with advice on further steps required.
  
On this page SUPERVISOR can edit existing ginstr applications or add new ginstr application to server.
+
===edit application page===
[[File:configure_applications.png|thumb|250px|none|configure application screen]]
+
[[File:edit_application.png|thumb|500px|'''edit application''' page]]
 +
When a <code>SUPERVISOR</code> clicks on an app name on '''[[#configure_applications|configure applications]]''' page then page where can edit that application is opened. This page is similar to the [[#new_application_page|''''new application'''' page]] with a few differences.
  
Here are displayed in table all applications which are uploaded to server with relevant informations like application version, minimum launcher version, who uploaded app and when app is uploaded.<br>
+
None of the fields on this page are editable but only an updated zip can be uploaded with same app id. Only the checkbox ''''Active By Default'''' editable allowing <code>SUPERVISOR</code> to change that status for each app at any time.
  
===new application page===
+
If the new app zip which should be uploaded has some changes in table structure then simple upload of new app version will not be possible and errors will be displayed when the upload is completed. In this case <code>SUPERVISOR</code> must remove the existing app and then create new app with same ID and upload that new zip with new table structure.
When SUPERVISOR click on "new application" button then new page is opened where can upload new ginstr application to server.
 
[[File:new_app_screen.png|thumb|250px|none|new application screen]]
 
In type drop down SUPERVISOR can choose type of application: private or public. Private application is published only for certain user and is visible only for that certain user and no one else. Public application can be active by default or not active by default. If public app is active by default then it will be displayed for all existing and future accounts. If public app is not active by default it will be displayed only for those accounts where SUPERVISOR enables that app.<br>
 
When private type is chosen fields owner of private application and Display Name become active and Active by Default checkbox becomes inactive. In owner of private application drop down SUPERVISOR chose username of user who will be able to use that application. In Display Name field SUPERVISOR enters name of app which will be displayed in SSO and in ginstr web. Active by Default checkbox is not editable for private applications because such application is visible only for user chosen in owner of private application drop down.<br>
 
When public type is chosen then fields owner of private application and Display Name become inactive and Active by Default checkbox becomes active. For public applications display name is defined in Liferay and Active by Default check box is editable because for public apps SUPERVISOR set via that checkbox if app will be visible for all users or only for users where app is manually enabled by SUPERVISOR/ADMINISTRATOR/MASTER.<br>
 
In app ID field must be entered for both private and public apps ID of app which is unique identifier of that app in system. App ID must be same as it is name of app zip file which should be uploaded. <br>
 
Once all set click on Browse button opens PC explorer where can choose app zip file form local PC. Once file is chosen click on save button starts upload process. Upload progress is displayed in bar below Browse button and once bar reach end and success message (with green background) is displayed then app is added to server and is displayed in configure applications page. If progress bar reach end and there was some problem during upload then error message (with red background) will be displayed with hint what should be corrected.<br>
 
  
===edit application page===
+
There are 3 fields on this edit application page that does not exist on new application page.
When SUPERVISOR click on some app name on configure applications page then page where can edit that application is opened. This page is similar to add new application page with few differences.
+
[[File:usage_statistic.png|thumb|500px|'''usage statistic''' CSV file example]]
[[File:edit_application.png|thumb|250px|none|edit application screen]]
+
:;<div style="display:inline-block;width:140px;height:auto;text-align:center;padding:0px 4px;vertical-align:middle;-moz-border-radius:3px;-webkit-border-radius:3px;border-radius:3px;background-color:silver"><span style="color:#404040;font-size:88%;font-weight:bold">usage statistic</span></div>: When a <code>SUPERVISOR</code> clicks on this button, a CSV file is exported with info about which accounts are using the selected application and how many records those accounts have in tables of that app.
None of the fields on this page is editable but only new zip can be uploaded with same app id. Only Active By Default checkbox is editable allowing SUPERVISOR to change that status for each app at any moment.<br>
+
:;<div style="display:inline-block;width:140px;height:auto;text-align:center;padding:0px 4px;vertical-align:middle;-moz-border-radius:3px;-webkit-border-radius:3px;border-radius:3px;background-color:silver"><span style="color:#404040;font-size:88%;font-weight:bold">remove tables</span></div>: When a <code>SUPERVISOR</code> clicks on this button then a dialog window will appear with security question.
If in new app zip which should be uploaded there were some changes in table structure then simple upload of new app version will not be possible but errors will be displayed in that case when upload is completed. In this case SUPERVISOR must remove existing app and then create new app with same ID and upload that new zip with new table structure. <br>
+
::If ''''yes'''' is chosen then all tables of the selected application will be deleted for all accounts where that app is enabled.
There are 3 fields on this edit application page that does not exist on new application page. Those are usage statistic, remove tables and remove ginstr app.<br>
+
::Removal of tables mean that tables are temporary deleted but data is permanently deleted. On next log in, an account which has that app enabled can generate tables again but new tables will be empty
When SUPERVISOR click on usage statistic button CSV file is exported with info about which accounts are using that application and how much records those accounts have in tables of that app.
+
:;<div style="display:inline-block;width:140px;height:auto;text-align:center;padding:0px 4px;vertical-align:middle;-moz-border-radius:3px;-webkit-border-radius:3px;border-radius:3px;background-color:silver"><span style="color:#404040;font-size:88%;font-weight:bold">remove ginstr app</span></div>: When a <code>SUPERVISOR</code> clicks on this button then a dialog window will appear with security question.
[[File:usage_statistic.png|thumb|250px|none|usage statistic CSV file example]]
+
::If ''''yes'''' is chosen then the selected application will be removed from SSO and [[ginstr web]] and also all tables and data will be removed for all accounts where app is enabled.
When SUPERVISOR click on remove tables button then dialog will appear with security question. If chose yes then all tables of that application and data in those tables will be deleted for all accounts where that app is enabled. Removal of tables mean that tables are temporary deleted but data is permanently deleted. On next log in account which have that app enabled can generate tables again but new tables will be empty<br>
 
When SUPERVISOR click on remove ginstr app button then dialog will appear with security question. If chose yes then application will be removed from SSO and ginstr web and also all tables and data will be removed for all accounts where app is enabled.
 

Revision as of 21:45, 4 November 2016

SSO Supervisor / Admin / Master Specific Content

General

In SSO server the following roles are defined, with ascending order for access level:

  • USER
  • ADMIN
  • MASTER
  • SUPERVISOR

"Standard" users (i.e. registered via sign up form) have role USER, which allows them to perform actions on themselves and their subaccounts only.

ADMIN, MASTER and SUPERVISOR are special user roles with increased permissions.

additional options in SUPERVISOR menu
action SUPERVISOR role MASTER role ADMIN role USER role
delete can delete all users can delete ADMIN & USER users only can delete USER users only cannot delete users
see can see all users can see ADMIN & USER users only can see USER users only can see himself and subusers only
modify can modify all users can modify ADMIN & USER users only can modify USER users only can modify himself and subusers only
add can add all users can add ADMIN & USER users only can add USER users only can modify himself and subusers only
update can update all users cannot update users cannot update users cannot update users

These roles are distinct from the roles defined in SSO Common Content roles section which are user-created roles for permissions on ginstr apps tables while SSO roles relate to permissions for SSO users.

When a user with SUPERVISOR permission logs in to SSO, the following additional options appear in the SSO lobby menu (accessed by hovering mouse over user name in top right corner of screen when logged in to SSO).

  • edit users
  • configure lobby
  • configure applications

When users with ADMIN or MASTER role log in to SSO, only the additional option 'edit users' appears in the SSO lobby menu.

edit users

File:list of users.png
'list of users' table

In this section are listed all SSO users with options to create new users, edit users, delete users and enable/disable ginstr for certain user.

This list of users is divided in multiple columns containing different info related to users. The table can be sorted by each of these columns by clicking on the sort iconsort.giflocated at the top right of each column heading.

DB num
this column contains id of user which is generated by SSO server automatically. Each id is a unique identifier for each user.
main account
this column is only filled if the user is a subaccount user, in which case it displays the main account of subaccount user
account status
existing account statuses are:
max subs
this column displays maximum number of subaccounts which user can create.
This number is defined by SUPERVISOR/ADMIN/MASTER when creating new user or editing existing user on edit users page or by ginstr subscription purchased from the ginstr shop.

On the far right side of page there are several links which when clicked open new pages or make some status changes on user accounts:-


edit

This page is the same as the page for creating new user which is opened by clicking on the
new user
button at the bottom of the 'list of users' page.
user's general information

At the top left side there are fields with general information related to the selected user account.

e-mail
In this field you can enter a personal or company e-mail address for the selected user.
password and re-enter password
These two fields are used to change the current password for the selected user.
NFC
In this field you can enter an NFC tag id, allowing the selected user to log in to ginstr apps by scanning this NFC tag on Android devices with built-in NFC technology.
first name and last name
In these fields you can modify first and last name which were entered on account creation.
mobile number
In this field you can enter a personal or company mobile number for the selected user.
company (optional)
In this field you can enter the name of the selected user's company.
attachments upload disable / enable and setting attachments limit section

At the bottom left side there is a section where SUPERVISOR/ADMIN/MASTER can set restrictions on attachments uploaded by the selected user.

disable chat support
This checkbox disables support chat so that the chat window will no longer be displayed to the selected user in either SSO or ginstr web.
enable upload of videos
if checked, the selected user can upload video files to ginstr web.
max. size per video in MB
defines the maximum size permitted for each video file uploaded by selected user.
max. size all videos in MB
defines the maximum total size permitted for all video files uploaded by the selected user.
enable upload of pictures
if checked, the selected user can upload image files to ginstr web.
max. size per picture in MB
defines the maximum size permitted for each image file uploaded by the selected user.
max. size all pictures in MB
defines the maximum total size permitted for all image files uploaded by the selected user.
enable upload of voice notes
if checked, selected user can upload audio files to ginstr web.
max. size per voice note in MB
defines the maximum size permitted for each audio file uploaded by the selected user.
max. size all voice notes in MB
defines the maximum total size permitted for all audio files uploaded by the selected user.
enable upload of documents
if checked, the selected user can upload document files to ginstr web.
max. size per document in MB
defines the maximum size permitted for each document file uploaded by selected user.
max. total size of all documents in MB
defines the maximum total size permitted for all document files uploaded by the selected user.
max. size account in MB
defines the maximum total size permitted for all files uploaded by the selected user.
user settings

In the top right corner there is a section related to the selected user account settings.

comment about user
This field can be used to save some comment(s) related to the selected user account.
account status
This drop down menu can be used to change the status of account (ACTIVE/SUSPENDED/DELETED)
role
This drop down menu can be used to change the SSO role of the selected account (USER/ADMIN/MASTER/SUPERVISOR)
enforce password expiry policy?
If checked, the selected user will be forced to renew password after certain period of time
ignore password and username minimum requirements for this account?
If checked, the default password requirements (password must have one number, one uppercase letter, one lowercase letter and at least eight characters) will not be disregarded on next renewal or change of password by the selected user
language
This drop down menu can be used to change the language in which SSO content will be displayed for the selected user
number of booked subaccounts
In this field you can define the maximum number of subaccounts which the selected user can create.
This field is not displayed if editing a subaccount.
Once this amount is set here manually, it is no longer set by a user's ginstr subscription, and can only be changed by a user with SUPERVISOR/ADMIN/MASTER role (unless a reset is performed).
account was created by
This field, which is only shown if the selected user is a subaccount, displays the name of the main account which created the subaccount.
section for editing user's applications
dialog for defining maximum amount of rows in each table of the selected app
dialog for generating demo data of PLUS applications

In the bottom right corner there is a list of all existing applications where SUPERVISOR/ADMIN/MASTER can enable/disable each app for the selected user, remove tables and data of certain apps for that user, set maximum amount of rows that can be added in table of some app and generate demo data for PLUS applications.

On top of this section there are 3 links :-

activate all
enables all applications in list below
deactivate all
disables all applications in list below
remove all tables
removes all tables and data from enabled applications in list below

Below these links is a list of modules (which are displayed in SSO lobby) and ginstr apps (which are displayed in the hide/show content section of the my account page on every main user account).

Before each module and application name there is a checkbox which can be used to manually activate / deactivate each separate module and application.

After each ginstr application name, one or more of the following icons will be displayed :-

delete icon.png delete icon
The delete icon appears after every ginstr application name, and when clicked opens a 'delete' dialog window with a security question.
If a SUPERVISOR/ADMIN/MASTER chooses 'yes' in the security dialog then all tables and data of the selected app belonging to the selected user will be removed.
pencil icon.png pencil icon
If tables of a ginstr app are already generated for the selected user, there will also be a pencil icon next to the application name.
Clicking on the pencil icon will open a dialog window to set the maximum amount of rows in each table of the selected app.
In this dialog window you can define the maximum amount of rows that can be added to each app table by user.
If the user attempts to add more rows than the maximum amount defined here, they will be shown an error message.
If no value is entered in a field, this means that an unlimited amount of rows can be added to table.
The limits applied here are saved when disabling an app for the selected user and are applied again if application is subsequently enabled for that user again.
arrow icon.png arrow icon
For PLUS applications there is an additional arrow icon.
Clicking on the arrow icon opens a dialog window for applying the predefined demo data for the language selected in the drop down to the PLUS app on the selected user account.

remove

Clicking the remove button on the 'list of users' table sets the selected account status to DELETED.

After several days account and all of its data will be completely removed.

EULA decisions

EULA decisions page

Clicking the EULA decisions button on the 'list of users' table opens a dialog box which contains a record of when the EULA (End User License Agreement) was accepted or declined by the selected user.

enable ginstr/disable ginstr

Disabling ginstr for a certain account means that the selected user will not be able to use the ginstr module at all.

Upon the expiry of a ginstr subscription, ginstr is automatically disabled for that account.

The enable ginstr/disable ginstr links in the 'list of users' table allows a SUPERVISOR/ADMIN/MASTER to manually enable/disable ginstr for some accounts.

In case ginstr is enabled/disabled manually then ginstr shop no longer has control over that account and all further actions in this regard on that account must be performed manually by a SUPERVISOR/ADMIN/MASTER (unless a reset is performed).

reset ginstr

Clicking on reset ginstr link for some account returns control of the account to ginstr shop and all changes previously made manually by SUPERVISOR/ADMIN/MASTER are overridden.

configure lobby

configure lobby page

In this section a SUPERVISOR can configure modules which are displayed in SSO server lobby.

For each module, the following modifications can be made:

  • name of module that will be displayed in SSO lobby
  • link to module address
  • icon which will be displayed in SSO lobby for that module
  • whether module should be displayed for all users by default in SSO lobby

configure applications

configure application page

On this page a SUPERVISOR can edit existing ginstr applications or add a new ginstr application to server.

The 'configure applications' table contains the following columns :-

  • App ID
  • Display Name
  • owner of private application
  • Active By Default
  • App version
  • Minimum ginstr launcher version
  • App Icon
  • Uploaded by
  • Uploaded on date

new application page

new application page
When a SUPERVISOR clicks on the
new application
button, a new page is opened with the following fields:-
type
This drop down contains two options - private or public
A private application is published only for a certain user and is visible only for that certain user and no one else.
A public application can be active by default or not active by default. If a public app is active by default then it will be displayed for all existing and future accounts. If a public app is not active by default it will be displayed only for those accounts where a SUPERVISOR enables that app.
owner of private application
If private is chosen from the type field, this drop down is used to select the username of user who will be able to use that application
Display Name
This field is used to enter the name of the new app which will be displayed in SSO and in ginstr web.
Active by Default
This checkbox is not editable for private applications because such application is visible only for user chosen in owner of private application drop down.
For a public app, enabling this checkbox means that the new app will be displayed for all existing and future accounts.
App ID
This field is for the unique identifier of the new app and must be entered for both private and public app. App ID must be in camel case and be same as the name of the application zip file.
  • After all required fields are filled, click on the
    Browse...
    button to select the new application .zip file from your local PC.
  • Once file is selected, click on the
    save
    button to start the upload process.
  • Upload progress is displayed in bar below the
    Browse...
    button.
  • When upload is complete, a success message (with green background) confirms that the app has been added to the server and is now displayed in the configure applications page. If there was a problem during upload then an error message (with red background) will be displayed with advice on further steps required.

edit application page

edit application page

When a SUPERVISOR clicks on an app name on configure applications page then page where can edit that application is opened. This page is similar to the 'new application' page with a few differences.

None of the fields on this page are editable but only an updated zip can be uploaded with same app id. Only the checkbox 'Active By Default' editable allowing SUPERVISOR to change that status for each app at any time.

If the new app zip which should be uploaded has some changes in table structure then simple upload of new app version will not be possible and errors will be displayed when the upload is completed. In this case SUPERVISOR must remove the existing app and then create new app with same ID and upload that new zip with new table structure.

There are 3 fields on this edit application page that does not exist on new application page.

usage statistic CSV file example
usage statistic
When a SUPERVISOR clicks on this button, a CSV file is exported with info about which accounts are using the selected application and how many records those accounts have in tables of that app.
remove tables
When a SUPERVISOR clicks on this button then a dialog window will appear with security question.
If 'yes' is chosen then all tables of the selected application will be deleted for all accounts where that app is enabled.
Removal of tables mean that tables are temporary deleted but data is permanently deleted. On next log in, an account which has that app enabled can generate tables again but new tables will be empty
remove ginstr app
When a SUPERVISOR clicks on this button then a dialog window will appear with security question.
If 'yes' is chosen then the selected application will be removed from SSO and ginstr web and also all tables and data will be removed for all accounts where app is enabled.