From wiki.ginstr.com
Jump to: navigation, search
m (edit users)
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
<div style="float:right; clear:both; margin-left:0.5em;">__TOC__</div>
 
<div style="float:right; clear:both; margin-left:0.5em;">__TOC__</div>
<span STYLE="font-size: xx-large">SSO Supervisor / Admin / Master Specific Content</span>
+
[[File:ginstr_logo_main.png|84px|link=]]<span STYLE="font-size: xx-large">&nbsp;SSO Supervisor / Admin / Master Specific Content</span>
[[Category:sso_manual]]
+
[[Category:SSO_manual]]
  
 
==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, in ascending order of access rights:
  
*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 the 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 [[sso_common_content#roles|<u>here</u>]], which are user-created roles for permissions on tables of ginstr apps 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>
 
  
 +
*edit users
 +
*configure lobby
 +
*configure applications
 +
 +
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]].
 +
 +
==edit users==
 +
[[File:list_of_users_table.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.
 +
 +
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|link=]] located 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 [[sso_common_content#subaccounts|subaccount]] user, in which case it displays the main account of the [[sso_common_content#subaccounts|subaccount]] user
 +
;<span id="account_status">account status</span>: existing account statuses are:
 +
:*<code>ACTIVE</code>
 +
:*<code>SUSPENDED</code> (if for example user tried log in with incorrect password several times)
 +
:*<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)
 +
:*<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: this column displays the maximum number of [[sso_common_content#subaccounts|subaccounts]] which the selected 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 the '''[[#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 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|edit]]
 +
*[[#remove|remove]]
 +
*[[#EULA_decisions|EULA decisions]]
 +
*[[#enable_ginstr/disable_ginstr|enable ginstr/disable ginstr]]
 +
*[[#reset ginstr|reset ginstr]]
 +
 +
----
 +
 +
===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.
 +
 +
:;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.
 +
 +
[[File:attachments_limits.png|thumb|500px|attachments upload disable / enable and setting attachments limit section]]
 +
At the bottom left side there is a section where a <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 is permitted to 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 is permitted to 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 is permitted to 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 is permitted to 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.
 +
 +
:;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 [[#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 the list below
 +
:;deactivate all: disables all applications in the list below
 +
:;remove all tables: removes all tables and data from the applications enabled in the list below
 +
 +
Below these links is a list of modules (which are displayed in [[sso_common_content#SSO_lobby|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]] for 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 :-
 +
 +
:;[[File:delete_icon.png|link=]] 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|link=]] 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|link=]] 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 <code>DELETED</code>.
 +
 +
After several days, the selected account and all of its data will be completely removed from the [[ginstr cloud]].
 +
 +
===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.
 +
 +
===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 [https://shop.ginstr.com/produkt-kategorie/subscriptions/ ginstr subscription], ginstr is automatically disabled for that account.
 +
 +
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.
 +
 +
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 the '''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.
 +
 +
==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]].
 +
 +
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
 +
 +
===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, the ''''new application'''' page is opened consisting of 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 applications are visible only to the user defined in the ''''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''' apps. App ID must be in [https://en.wikipedia.org/wiki/Camel_case camel case] and be the same as the name of the application zip file.
 +
 +
: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.
 +
 +
:Once the .zip 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. The upload progress is displayed in the 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.
 +
 +
:When the 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 the upload then an error message (with red background) will be displayed with advice on further steps required.
 +
 +
===edit application page===
 +
[[File:edit_application.png|thumb|500px|'''edit application''' page]]
 +
When a <code>SUPERVISOR</code> clicks on an app name on the '''[[#configure_applications|configure applications]]''' page, the ''''edit application'''' page is opened. This page is similar to the [[#new_application_page|''''new application'''' page]] with a few differences.
 +
 +
With the exception of the checkbox ''''Active By Default'''', none of the fields on this page are editable - only an updated zip can be uploaded with same app id.
  
S can delete all, M can delete A and U users, A can delete U users, U cannot delete<br>
+
If the new application zip file has some changes in table structure then a simple upload of new app version will not be possible and errors will be displayed when the upload is completed. In this case, a <code>SUPERVISOR</code> must remove the existing app and then create new app with same ID and upload the new zip containing the new table structure.
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>
 
  
 +
At the bottom of the '''edit application''' page, there are 3 buttons that do not exist on the '''new application''' page:
 +
[[File:usage_statistic.png|thumb|500px|'''usage statistic''' CSV file example]]
 +
:;<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 containing information regarding which accounts are using the selected application and how many 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 tables</span></div>: When a <code>SUPERVISOR</code> clicks on this button, a dialog window will appear with a 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 means that the app tables are temporary deleted and their 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
 +
:;<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, 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 the app is enabled.
  
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.
+
=Remote Commands=
  
 +
For troubleshooting/debugging purposes it is possible to execute certain commands on user devices remotely from [[ginstr web]].
  
When user with SUPERVISOR permission log in to SSO additional options appear in menu in top right corner:
+
The '''Remote Commands''' feature can help to greatly reduce the length of time required to resolve ginstr launcher issues on specific user accounts or specific devices by remotely accessing system settings and automatically retrieving relevant information from devices without the direct involvement of the end user.
  
*edit users
+
The [[#LauncherPreparedCommands|<code>LauncherPreparedCommands</code> system table]] is used to prepare the remote commands for execution, and the results of executed commands are reported in the [[#LauncherExecutedCommands|<code>LauncherExecutedCommands</code> system table]].
*configure lobby
 
*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
+
* for <code>SUPERVISOR</code> users, '''Remote Commands''' can be used on all devices belonging to all user accounts.
 +
* for <code>Main Users</code>, '''Remote Commands''' can be used only on devices previously connected with the Main User account.
  
 +
==<code>LauncherCommands</code>==
  
 +
The <code>LauncherCommands</code> system table provides a list of possible remote commands as detailed below.
  
[[File:supervisor_menu.png|thumb|250px|none|additional options in SUPERVISOR menu]]
+
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
 +
|-
 +
! scope="col" | Name
 +
! scope="col" | id
 +
! scope="col" | Description
 +
|-
 +
| title="Name" | <span id="enableSystemLog">enable system log</span>
 +
| title="id" | <code>enableSystemLog</code>
 +
| title="Description" | Enables system log on device
 +
|-
 +
| title="Name" | <span id="disableSystemLog">disable system log
 +
| title="id" | <code>disableSystemLog</code>
 +
| title="Description" | Disables system log on device
 +
|-
 +
| title="Name" | <span id="getSystemLog">get system log</span>
 +
| title="id" | <code>getSystemLog</code>
 +
| title="Description" | Retrieves system log files from specific device
 +
|-
 +
| title="Name" | <span id="deleteSystemLog">delete system log</span>
 +
| title="id" | <code>deleteSystemLog</code>
 +
| title="Description" | Deletes system log files on device
 +
|-
 +
| title="Name" | <span id="enableKioskMode">enable kiosk mode</span>
 +
| title="id" | <code>enableKioskMode</code>
 +
| title="Description" | Enables [[kiosk mode]] for specific device<br> (see [[#commandParams|<u>here</u>]] for more information)
 +
|-
 +
| title="Name" | <span id="disableKioskMode">disable kiosk mode</span>
 +
| title="id" | <code>disableKioskMode</code>
 +
| title="Description" | Disables [[kiosk mode]] for specific device
 +
|-
 +
| title="Name" | <span id="getDatabase">get database</span>
 +
| title="id" | <code>getDatabase</code>
 +
| title="Description" | Retrieves internal storage database from specific device
 +
|-
 +
| title="Name" | <span id="getDeviceSerialNumber">get device serial number</span>
 +
| title="id" | <code>getDeviceSerialNumber</code>
 +
| title="Description" | Retrieves device serial number from specific device
 +
|-
 +
| title="Name" | <span id="getLauncherInfo">get launcher information</span>
 +
| title="id" | <code>getLauncherInfo</code>
 +
| title="Description" | Retrieves launcher version, list of all installed apps and their versions
 +
|-
 +
| title="Name" | <span id="getScreenshot">get screenshot</span>
 +
| title="id" | <code>getScreenshot</code>
 +
| title="Description" | Initiates screenshot capture and retrieval from specific device
 +
|-
 +
| title="Name" | <span id="getSettings">get settings</span>
 +
| title="id" | <code>getSettings</code>
 +
| title="Description" | Retrieves ginstr launcher settings from [https://developer.android.com/reference/android/content/SharedPreferences.html SharedPreferences] for specific device
 +
|-
 +
| title="Name" | <span id="getSettings">send SMS
 +
| title="id" | <code>sendSMS</code>
 +
| title="Description" | Sends an SMS from device to specified phone number<br> (see [[#commandParams|<u>here</u>]] for more information)
 +
|-
 +
| title="Name" | <span id="getSettings">Update launcher to latest version
 +
| title="id" | <code>forceLauncherUpdate</code>
 +
| title="Description" |  Checks if installed ginstr launcher version is equal to launcher version specified and if not, blocks all replication threads and ginstr app execution and opens [https://play.google.com/store/apps/details?id=com.ginstr Google Play Store] on device to update to latest version<br> (see [[#commandParams|<u>here</u>]] for more information)
 +
<!-- NOT YET IMPLEMENTED
 +
| title="Name" | clean install all ginstr apps
 +
| title="id" | <code>cleanInstallApps</code>
 +
| title="Description" | Initiates a clean install of all ginstr apps on specific device
 +
|-
 +
| title="Name" | execute database compaction
 +
| title="id" | <code>compactDatabase</code>
 +
| title="Description" | Deletes all legacy data from database on specific device
 +
|-
 +
| title="Name" | get ginstr launcher base folder mapping of all files
 +
| title="id" | <code>getBaseFolderTree</code>
 +
| title="Description" | Retrieves base folder tree view from specific device
 +
|-
 +
| title="Name" | reinstall specific ginstr app
 +
| title="id" | <code>reinstallApp</code>
 +
| title="Description" | Reinstalls specified ginstr app on specific device<br> (see [[#commandParams|<u>here</u>]] for more information)
 +
|-
 +
| title="Name" | get device hardware info
 +
| title="id" | <code>getDeviceHardwareInfo</code>
 +
| title="Description" | Retrieves device hardware information from specific device
 +
-->
 +
|}
  
 +
==<code>LauncherPreparedCommands</code>==
  
==edit users==
+
The <code>LauncherPreparedCommands</code> system table is used to prepare the remote commands for execution and consists of the following columns :-
  
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.
+
* [[#commandDescription|commandDescription]]
 +
* [[#companyName|companyName]]
 +
* [[#userName|userName]]
 +
* [[#deviceSerialNumber|deviceSerialNumber]]
 +
* [[#command|command]]
 +
* [[#commandParams|commandParams]]
 +
* [[#network|network]]
 +
* [[#eventType|eventType]]
 +
* [[#validFrom|validFrom]]
 +
* [[#validUntil|validUntil]]
 +
* [[#active|active]]
  
 +
===commandDescription===
  
[[File:list_of_users.png|thumb|250px|none|list of users]]
+
The column '''commandDescription''' is required to define a <u>unique</u> description for each command to be executed.
  
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.
+
===companyName===
  
'''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>
+
The column '''companyName''' is required to define which user accounts are targeted by the remote command. Each main user account has a unique, 6 digit identifier number which is displayed in brackets next to their user name in [[setup_ginstr_web#General_Settings|ginstr web general settings]] (displayed to user logged in to [[ginstr web]] upon clicking 'setup' in the drop down menu at top right of screen).
'''main account''' - this column have value only if user is subaccount user. In this column is displayed main account of subaccount user<br>
 
'''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>
 
'''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.
 
  
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:
+
This identifier number should be entered in to the '''companyName''' field in the format <code>mainUser101010</code>. The remote command would therefore be executed only on the account with identifier number 101010, and also on the subaccounts belonging to that main user account.
  
*edit
+
<code>SUPERVISOR</code> users also have the option to target <u>all</u> ginstr user accounts by entering <code>all</code> in to the '''companyName''' field.
*remove
 
*EULA decisions
 
*enable ginstr/disable ginstr
 
*reset ginstr
 
  
 +
:;Note: using the <code>all</code> option without filling either [[#deviceSerialNumber|deviceSerialNumber]] and/or [[#userName|userName]] fields will execute the remote command for all users of the ginstr platform and should be used with caution in exceptional circumstances only
  
===edit===
+
===userName===
  
 +
The column '''userName''' is used optionally to target a specific user name belonging to the main user account defined in the '''companyName''' column.
  
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>
+
The specified user name should be entered in to the '''userName''' field in the format <code>user@email.com</code>
  
 +
===deviceSerialNumber===
  
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.
+
The column '''deviceSerialNumber''' is used optionally to target a specific device only belonging to the main user account defined in the '''companyName''' column.
[[File:edit_user_data.png|thumb|250px|none|user's general information]]
 
  
 +
The specified device serial number should be entered in to the '''deviceSerialNumber''' field in the format <code>123456789123456</code>
  
 +
:;Note: the [[#deviceSerialNumber|deviceSerialNumber]] field can be used in conjunction with the [[#userName|userName]] field to target a specific user on a specific device
  
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.
+
===command===
[[File:attachments_limits.png|thumb|250px|none|attachments upload disable / enable and setting attachments limit section]]
 
  
 +
The column '''command''' is required to select the desired remote command from a drop down menu.
  
 +
The remote commands available are listed in the [[#LauncherCommands|<code>LauncherCommands</code> system table]].
  
In top right corner there is section related to settings of user account.
+
===commandParams===
[[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.
+
The column '''commandParams''' is required only for the following remote commands in order to specify  necessary parameters.
[[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]]
 
  
 +
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
 +
|-
 +
! scope="col" | Name
 +
! scope="col" | id
 +
! scope="col" | Description
 +
! scope="col" | commandParams
 +
! scope="col" | commandParams example
 +
|-
 +
| title="Name" | enable kiosk mode
 +
| title="id" | <code>enableKioskMode</code>
 +
| title="Description" | Specifies password to be set for [[kiosk mode]] on device
 +
| title="commandParams" | kiosk mode password
 +
| title="commandParams example" | <code>kioskPa55word</code>
 +
|-
 +
| title="Name" | send SMS
 +
| title="id" | <code>sendSMS</code>
 +
| title="Description" | Specifies recipient phone number and message to be sent via SMS
 +
| title="commandParams" | <code>phonenumber|message</code>
 +
| title="commandParams example" | <code>+385916665519|Hello world</code>
 +
|-
 +
| title="Name" | Update launcher to latest version
 +
| title="id" | <code>forceLauncherUpdate</code>
 +
| title="Description" | Specifies ginstr launcher version required on device.<br> If device has an earlier launcher version installed, [https://play.google.com/store/apps/details?id=com.ginstr Google Play Store] will be opened on device and the user will be instructed to update to latest version
 +
| title="commandParams" | launcher version
 +
| title="commandParams example" | <code>15072016</code>
 +
<!-- NOT YET IMPLEMENTED
 +
| title="Name" | reinstall specific ginstr app
 +
| title="id" | <code>reinstallApp</code>
 +
| title="Description" | Specifies which ginstr app should be reinstalled
 +
| title="commandParams" | ginstrAppId
 +
| title="commandParams example" | <code>containerHire</code>
 +
-->
 +
|}
  
 +
===network===
  
 +
The column '''network''' is required to define which network the specified device(s) should be connected to when the remote command is executed.
  
===remove===
+
* With <code>WIFI</code> selected, only devices connected to the internet via a WiFi connection will be targeted by the remote command (when [[#active|active]])
 +
* With <code>3G</code> selected, only devices connected to the internet via a 3G network connection will be targeted by the remote command (when [[#active|active]])
 +
* With <code>ALL</code> selected, all devices connected to the internet via WiFi or 3G network connection will be targeted by the remote command (when [[#active|active]])
  
Click on this link will set that account status to DELETED. After several days account and all of its data will be completely removed.
+
===eventType===
  
 +
The column '''eventType''' is required to define when the remote command should be executed.
  
 +
* With <code>APPSTART</code> selected, the remote command will (when [[#active|active]]) be executed when the user starts a ginstr app
 +
* With <code>LOGIN</code> selected, the remote command will (when [[#active|active]]) be executed when the user logs in to a ginstr app or ginstr launcher
 +
* With <code>IMMEDIATELY</code> selected, the remote command will (when [[#active|active]]) be executed immediately
  
===EULA decisions===
+
===validFrom===
  
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.
+
The column '''validFrom''' is used optionally to define a start date/time, after which the remote command is executed (when [[#active|active]]).
[[File:EULA_decisions.png|thumb|250px|none|EULA decisions page]]
 
  
 +
===validUntil===
  
 +
The column '''validUntil''' is used optionally to define an end date/time, after which the remote command is no longer executed.
  
===enable ginstr/disable ginstr===
+
===active===
  
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.
+
The column '''active''' provides the option to toggle each remote command on/off with a double-click.
  
 +
Care should be taken to ensure that all other fields have been set up correctly before setting a remote command to '''active''' status.
  
 +
==<code>LauncherExecutedCommands</code>==
  
===reset ginstr===
+
The <code>LauncherExecutedCommands</code> system table provides an overview of the result of each remote command executed.
  
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.
+
The '''companyName''' column displays the [[#companyName|companyName]] (user account id) targeted by each remote command executed.
  
 +
The '''userName''' column displays the [[#userName|userName]] targeted by each remote command executed.
  
 +
The '''deviceSerialNumber''' column displays the [[#deviceSerialNumber|deviceSerialNumber]] targeted by each remote command executed.
  
==configure lobby==
+
The '''command''' column displays the [[#commandDescription|commandDescription]] assigned to each remote command executed.
  
 +
The '''timestamp''' column displays the date & time when each remote command was executed.
  
In this section SUPERVISOR can configure modules which are displayed in SSO server lobby.
+
The '''attachment''' column contains a link to any files retrieved by an executed remote command. Retrieved files can be downloaded to local PC by clicking the filename (e.g. '''report.zip''')
[[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
+
The '''result''' column displays whether each executed remote command was a <code>SUCCESS</code> or if it <code>FAILED</code> for some reason.

Latest revision as of 19:37, 17 May 2018

ginstr logo main.png SSO Supervisor / Admin / Master Specific Content

General

In SSO server the following roles are defined, in ascending order of access rights:

  • USER
  • ADMIN
  • MASTER
  • SUPERVISOR

"Standard" users (i.e. registered via sign up form) have the 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 here, which are user-created roles for permissions on tables of ginstr apps 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

'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.gif located 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 the subaccount user
account status
existing account statuses are:
max subs
this column displays the maximum number of subaccounts which the selected user can create.
This number is defined by SUPERVISOR/ADMIN/MASTER when creating new user or editing existing user on the 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 a 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 is permitted to 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 is permitted to 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 is permitted to 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 is permitted to 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 the list below
deactivate all
disables all applications in the list below
remove all tables
removes all tables and data from the applications enabled in the 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 for 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, the selected account and all of its data will be completely removed from the ginstr cloud.

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 the 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, the 'new application' page is opened consisting of 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 applications are visible only to the user defined in the '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 apps. App ID must be in camel case and be the 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 the .zip file is selected, click on the
save
button to start the upload process. The upload progress is displayed in the bar below the
Browse...
button.
When the 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 the 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 the configure applications page, the 'edit application' page is opened. This page is similar to the 'new application' page with a few differences.

With the exception of the checkbox 'Active By Default', none of the fields on this page are editable - only an updated zip can be uploaded with same app id.

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

At the bottom of the edit application page, there are 3 buttons that do not exist on the new application page:

usage statistic CSV file example
usage statistic
When a SUPERVISOR clicks on this button, a CSV file is exported containing information regarding 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, a dialog window will appear with a 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 means that the app tables are temporary deleted and their 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, 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 the app is enabled.

Remote Commands

For troubleshooting/debugging purposes it is possible to execute certain commands on user devices remotely from ginstr web.

The Remote Commands feature can help to greatly reduce the length of time required to resolve ginstr launcher issues on specific user accounts or specific devices by remotely accessing system settings and automatically retrieving relevant information from devices without the direct involvement of the end user.

The LauncherPreparedCommands system table is used to prepare the remote commands for execution, and the results of executed commands are reported in the LauncherExecutedCommands system table.

  • for SUPERVISOR users, Remote Commands can be used on all devices belonging to all user accounts.
  • for Main Users, Remote Commands can be used only on devices previously connected with the Main User account.

LauncherCommands

The LauncherCommands system table provides a list of possible remote commands as detailed below.

Name id Description
enable system log enableSystemLog Enables system log on device
disable system log disableSystemLog Disables system log on device
get system log getSystemLog Retrieves system log files from specific device
delete system log deleteSystemLog Deletes system log files on device
enable kiosk mode enableKioskMode Enables kiosk mode for specific device
(see here for more information)
disable kiosk mode disableKioskMode Disables kiosk mode for specific device
get database getDatabase Retrieves internal storage database from specific device
get device serial number getDeviceSerialNumber Retrieves device serial number from specific device
get launcher information getLauncherInfo Retrieves launcher version, list of all installed apps and their versions
get screenshot getScreenshot Initiates screenshot capture and retrieval from specific device
get settings getSettings Retrieves ginstr launcher settings from SharedPreferences for specific device
send SMS sendSMS Sends an SMS from device to specified phone number
(see here for more information)
Update launcher to latest version forceLauncherUpdate Checks if installed ginstr launcher version is equal to launcher version specified and if not, blocks all replication threads and ginstr app execution and opens Google Play Store on device to update to latest version
(see here for more information)

LauncherPreparedCommands

The LauncherPreparedCommands system table is used to prepare the remote commands for execution and consists of the following columns :-

commandDescription

The column commandDescription is required to define a unique description for each command to be executed.

companyName

The column companyName is required to define which user accounts are targeted by the remote command. Each main user account has a unique, 6 digit identifier number which is displayed in brackets next to their user name in ginstr web general settings (displayed to user logged in to ginstr web upon clicking 'setup' in the drop down menu at top right of screen).

This identifier number should be entered in to the companyName field in the format mainUser101010. The remote command would therefore be executed only on the account with identifier number 101010, and also on the subaccounts belonging to that main user account.

SUPERVISOR users also have the option to target all ginstr user accounts by entering all in to the companyName field.

Note
using the all option without filling either deviceSerialNumber and/or userName fields will execute the remote command for all users of the ginstr platform and should be used with caution in exceptional circumstances only

userName

The column userName is used optionally to target a specific user name belonging to the main user account defined in the companyName column.

The specified user name should be entered in to the userName field in the format user@email.com

deviceSerialNumber

The column deviceSerialNumber is used optionally to target a specific device only belonging to the main user account defined in the companyName column.

The specified device serial number should be entered in to the deviceSerialNumber field in the format 123456789123456

Note
the deviceSerialNumber field can be used in conjunction with the userName field to target a specific user on a specific device

command

The column command is required to select the desired remote command from a drop down menu.

The remote commands available are listed in the LauncherCommands system table.

commandParams

The column commandParams is required only for the following remote commands in order to specify necessary parameters.

Name id Description commandParams commandParams example
enable kiosk mode enableKioskMode Specifies password to be set for kiosk mode on device kiosk mode password kioskPa55word
send SMS sendSMS Specifies recipient phone number and message to be sent via SMS phonenumber|message +385916665519|Hello world
Update launcher to latest version forceLauncherUpdate Specifies ginstr launcher version required on device.
If device has an earlier launcher version installed, Google Play Store will be opened on device and the user will be instructed to update to latest version
launcher version 15072016

network

The column network is required to define which network the specified device(s) should be connected to when the remote command is executed.

  • With WIFI selected, only devices connected to the internet via a WiFi connection will be targeted by the remote command (when active)
  • With 3G selected, only devices connected to the internet via a 3G network connection will be targeted by the remote command (when active)
  • With ALL selected, all devices connected to the internet via WiFi or 3G network connection will be targeted by the remote command (when active)

eventType

The column eventType is required to define when the remote command should be executed.

  • With APPSTART selected, the remote command will (when active) be executed when the user starts a ginstr app
  • With LOGIN selected, the remote command will (when active) be executed when the user logs in to a ginstr app or ginstr launcher
  • With IMMEDIATELY selected, the remote command will (when active) be executed immediately

validFrom

The column validFrom is used optionally to define a start date/time, after which the remote command is executed (when active).

validUntil

The column validUntil is used optionally to define an end date/time, after which the remote command is no longer executed.

active

The column active provides the option to toggle each remote command on/off with a double-click.

Care should be taken to ensure that all other fields have been set up correctly before setting a remote command to active status.

LauncherExecutedCommands

The LauncherExecutedCommands system table provides an overview of the result of each remote command executed.

The companyName column displays the companyName (user account id) targeted by each remote command executed.

The userName column displays the userName targeted by each remote command executed.

The deviceSerialNumber column displays the deviceSerialNumber targeted by each remote command executed.

The command column displays the commandDescription assigned to each remote command executed.

The timestamp column displays the date & time when each remote command was executed.

The attachment column contains a link to any files retrieved by an executed remote command. Retrieved files can be downloaded to local PC by clicking the filename (e.g. report.zip)

The result column displays whether each executed remote command was a SUCCESS or if it FAILED for some reason.