Engee documentation

Administration and licensing

There are two types of licences in Engee:

  • Sublicence - a licence containing the type, duration, status, size and date of the product. Adding sub-licences increases the functionality and/or extends the duration of the master licence.

  • A Master Licence is a group of sub-licences under the control of an administrator within a specific organisation.

Administration and licensing is conducted in personal account Engee under My Organisations engee organizations icon. To access this section, click on the engee organizations icon icon and click on the name of your organisation:

my organizations page

New features will now be available in the My Organisations section:

license 2

  1. Information - editing information about the organisation.

  2. Configurations - managing master licences and setting up users within a master licence.

  3. Users (entire organisation) - administer users within the organisation.

Information

There are four tabs available in the Information admin section:

  1. Basic - edit basic information about the organisation;

  2. Details - update details of the organisation;

  3. Divisions - setting up the organisation’s divisions;

  4. Metrics - tracking metrics within the organisation.

license 10

In the Metrics tab, you can filter and sort metrics both by metric type and by user:

license metrics 1

By default, the list of users can be hidden. To display users, click on the multi-dot ellipsis icon in the right corner to open the pop-up menu, select Hide/Show Columns and tick the box next to Engee ID:

ellipsis menu 1

If the Engee ID column is not added:

  • Displays the total number of Engee application runs for the entire organisation (including all users).

  • Displays the total time of all user sessions for this organisation.

If the column is added:

  • Displays the number of Engee application launches for each user in the organisation.

  • Displays the total session time for each user.

Implemented for convenience:

  • Resetting all table filters using the button reset table button 1.

  • Sorting and filtering of data by metrics type and by Engee ID (if this column is available in the table).

  • Selection of data display period: 30, 90, 180 days, year or unlimited.

  • Downloading the table as a CSV file.

Configurations

The Configurations section shows the available master licences.

license 22

Click open spoiler button to view the full master licence details:

license 23

You can set an auxiliary name for a master licence. To do this, move the cursor over the name and click on the icon pen button graphs:

namechanger config

The name of the master licence will be shown in the top right corner of your personal cabinet next to the name of the organisation:

namechanger name config


To go to the master licence, go to the Configurations section and click on the name of the licence. The section consists of tabs Licences, Users, Profiles, Associations:

licence xx -> licence xx 1

Licences

The Licences tab displays all available resources (sublicences) of the master licence. Each sub-licence is a specific product provided by Engee:

lx 1 1

Core Resources provided as products:

  • CPU - number of virtual processor cores allocated for operation in the Engee application.

  • RAM - the amount of RAM available for operation of the computing module in the Engee application.

  • Disk Drive - the amount of disc space allocated for data storage.

  • Inactivity timeout - time of inactivity of the user, after which the session is automatically terminated. Inactivity starts when mouse movement and keystrokes stop.

  • Usage Revolving per user hr/m - resource usage limit set in hours or minutes, updated for each user in a given period.

For more information about resources when starting a session, see Starting an Engee session.


Users (in a master licence)

On the Users tab, the administrator can add already registered users, send invitations to new ones, disable them, and edit the limits within the selected master licence.

user monitoring lk

Editing limits on the Users tab allows you to configure session start parameters for specific users. To configure the parameters of user groups, go to the Profiles tab.
To invite multiple users at the same time, use the Associations tab.
  • To add to a master licence, click add user button 1 and select one of the offered options:

    add user 1

    • Add by Engee ID - adds a user from those already registered in Engee;

    • Send invitation - adds a user not previously registered in Engee by E-mail (mandatory) and phone number.

      Process of inviting an unregistered user

      Invitation consists of three steps:

      1. Enter the E-mail (mandatory) and mobile phone of the user. Then click Next:

        add user 2

      2. Select a master licence user profile. Profiles are configured in the Profiles tab. Afterwards, click Next:

        add user 3

      3. There are associations for each profile, customisable in the Associations tab and responsible for automatically adding users:

        • Enable automatic addition so that the user is automatically added to the master licence;

        • Disable auto-add so that the user is in the "Waiting to connect" status and waiting for administrator approval to be added to the master licence.

          add user 4

        If the E-mail is entered correctly, the user will receive an e-mail alert with a link to go to Engee.

  • To remove from the master licence, tick the box to the left of the user name, click user disc 2 and select Disable:

    user disc 1

  • To edit a specific user’s session startup limits, tick the tick box to the left of the user’s name, click on the multi-dot button ellipsis icon and select Edit Limits.

    limits edit 1

    In the window that opens, select the parameters to be changed:

    limits edit

    When saving the change, select:

    • Apply - the changes will affect only the selected user and will not affect other users or profile settings in the Profiles tab.

    • Apply to Profile - the changes will be saved to the settings of the associated profile in the Profiles tab and applied to all users associated with that profile.


Profiles

Profiles can be added/deleted, renamed.
The Profiles tab is used to configure parameters for launching user groups. To change parameters for a specific user, go to the Users tab, select the required user, click on the dot icon ellipsis icon and select Edit Limits.

On the Profiles tab, the administrator controls the parameters for launching user group sessions and sets resource thresholds:

license 19

Once the thresholds are saved, the user will be limited to launch parameters depending on the profile issued. The user can see the resources available to him in the Control Panel section control panel 1 by clicking the gear button:

start settings x

The user can adjust startup resources between thresholds (if such resources are available) and select the Engee version:

start settings 1 -> start settings x 1

The bottom left corner of the expanded sidebar indicates the version of the personal account, not Engee.

start settings x 2


Associations

In the Associations tab, the administrator adds/disables users in a particular master licence and assigns them to profiles:

license 18

To expand the associations, select the desired profile and left-click on it:

license 18 1 1

Associations can be automated with auto add:

license 21

  • On - the user will be immediately added to the selected master licence profile without administrator approval and will be able to use Engee according to the profile settings;

  • Disabled - users will not be added automatically. They will remain in the "Waiting to connect" status on the Users tab and will not get access to the master licence without administrator approval.

For example, with automatic addition enabled, users added to a priority profile will immediately get access to Engee with the resources of that profile.

The administrator can set rules for automatically adding/removing users by profile using lists. Each profile has its own whitelists and stop lists:

  • White list - automatically adds users to the master licence (subject to auto-add settings).

  • Stop list - rejects users.

Profiles have their own configurable priorities:

profile priorities

For example, if a user is whitelisted in both profiles, he or she is assigned to the profile with the higher priority.

Rules for automatic user allocation

There are 8 lists in the configuration profiles - 4 each in white and stop lists, namely by domain, by E-mail, by phone and by Engee ID. Each list (whitelist and stop list) has its own rules:

  • When manually adding a user by Engee ID, the rule for the whitelist is created, the rule for the stop list (if any) is removed.

  • When manually deleting a user is added by Engee ID a rule for the stop list is created, a rule for the whitelist (if any) is deleted.

  • Rules by Engee ID cannot exist for white and stop lists at the same time.

  • The same rules on Engee ID cannot whitelist different profiles of the same master licence.

  • When auto-add is enabled, users are automatically whitelisted to the master licence and profile when they register or change their details.

  • When auto-add is disabled, users get the status "Waiting to connect".

  • A user added with auto-add enabled can get to the "Waiting to connect" status if there are no resources to connect.

  • A user goes to the profile with the highest priority if the rule matches across multiple profiles.

  • Whitelisting by Engee ID ignores profile priorities.

Users (entire organisation)

To view all users in an organisation, click on the My Organisations icon engee organizations icon and select Users:

user option 1

Do not confuse the Users tab in Configurations with the standalone Users section:

  • In the first case - the administrator manages users within a specific master licence;

  • In the second case, within an organisation.

In the Users section, the administrator can see a list of all users in the organisation, their roles and contact details:

license 24

By default, the list of users can be hidden. To display users, click on the multi-dot ellipsis icon in the right corner to open the pop-up menu, select Hide/Show Columns and tick the box next to Engee ID:

To add additional columns to the user list, click on the multi-dot user disc 2 on the right and select Hide/Show Columns. To reset the list filters, click reset table button 1.

In this section, the administrator can:

  • Approve user requests to join the organisation’s master list.

  • Reject users joining the organisation’s master licence.

  • Disconnect users from the master licence. Disconnected users will appear in the "Not Connected" status and will not occupy master licence resources (dedicated sublicences). Disconnecting from the master licence does not disconnect from the organisation.

  • Deactivate the user’s connection to the organisation. Deactivating the linkage completely removes the user from the organisation.

  • Change user’s password. This option is useful if the user has lost their mail/password.

    license 25

Process of changing user password
  1. Tick the box to the left of the user you plan to change the password for and select Change Password in the actions at user disc 2. In the window that appears, click Generate new password:

    password changing 1

  2. The new password is created automatically and copied to the clipboard.

    password changing 2

  3. The password can be copied an unlimited number of times. Then click Apply new password:

    password changing 3

All actions except changing the password can be performed for several users at the same time. To do this, tick the required users.