Administrator User Documentation

Welcome to the Administrator User Documentation for gIQ. This manual explains some of the functions of an administrator. It will assume that this role has administration priviliges for all areas of the product. It is possible to give the responsibility of administering individual sections to individual people through configuration of user roles.

Updated: January 14, 2024
Updated By: Shaun Campbell

1. Introduction

gIQ allows for fine grain role assignment in the product. An organisation can assign an administrator to each function withn the product. This guide will combine all of the administration features into a single document. For ease of navigation, please use the menu items to the right.

2. Administration Panel

In order to access the administration panel a user must be assigned with a permission for Admin Users.

Inside the administration panel a user will find three different areas: "Users", "Roles" and "Settings".

For more detailed information and the workflows required, please consult the user guides section of the documentation.

Users

This is the panel where a user with the admin users permission can administer the user.

The first option is to add a new user. The system gives a user the workflow to add a new user by entering their details on the form. It will ask for items such the users full name, a username (which the user will use to login), email address and roles. It will also prompt the admin user to enter an initial password. The email address is used for user password recovery. It is recommended that the force user to change password option is enabled. Once the user account is created, there will be a notification which indicates that the account has been created successfully.

Other options in this panel include the ability to deactivate or reactivate a user, delete a user or edit the user. The edit user option is where an administrator can reset a password. Once a user is deleted it is not possible to recover the account.

Managing User Accounts in Admin Panel

Creation Date: July 31, 2023
Created By: Shaun Campbell

1. Click on your avatar

2. Click on Admin Panel…

3. This opens the user management by default. To create a new user select "New User"

4. Type the users full name

5. Generate a user name. This will be their login username.

6. Type their email address

7. Re-enter it to verify that no mistakes were made

8. Click on open and select a role

It is important that there are roles in the system already. gIQ only comes with an administrator by default.

9. Click on the role

10. Type a password for the user, then repeat it in the next box.

11. It is highly recommended that you force the user to change the password on first log in.

However, this can be disabled if required.

12. Click on Create User

13. An alert shows for a few seconds to inform you that it has been successful

14. The system assumes you want to add another.

Repeat the steps if a new user is required. Otherwise, select close.

15. Now the user is listed in the user management.

16. Clicking on the three dots will show some options for the administrator.

Edit allows you to change the password of a user. Deactivate (or activate) is possible, as is deleting the user.

Roles

gIQ is flexible to allow an admin user to define a user role. Each user role will have a different number of permissions assigned to it, allowing it to be flexible.

There is a concept of a basic user role. This role does not have any other special permissions and can only see the basic product features of exploration only. All other features, combined with the ability to upload data, is disabled for this basic user role.

Multiple Roles

It is worth noting that a user can be assigned multiple roles at the same time. If one role does not allow for a permission A, but another role does, and the user is given both roles, then the user will have access to permission A.

To create a new role the admin user should select new role from the Roles panel. Once the new role name is entered, the user can then select the different permissions to be assigned to that role. Alternatively, the admin user can copy and existing role if the intent is to make small changes. Click on the burger icon next to the role that needs to be duplicated. The admin user can also rename a role or delete a role using the same method.

Inside the permission section the admin user will see two different options - check boxes and toggles. The toggle will enable the feature for the user, while the check boxes allows the admin user to define the permissions allowed for that user role. This will become more fine grained soon, allowing for clearer user roles.

Deleting a role in use

If a role in use gets deleted, then the user operating with that role will revert to the most basic user role.

Create a new role

A user can be assigned one or more roles. A role is a set of permissions that an assigned user can perform. This guide will explain the process of creating a new role in the system.

1. User Management…

We are assuming that we are starting with user management.

2. Click on roles

3. This is the new roles screen

4. Click on add New Role

5. Type the name of the new role

6. Click on Create

7. Assign some permissions for the role

8. There is a fine grain level of permissions available.

9. Finish

Once all of the permissions have been assigned it is possible to then use the role when creating a user.

Settings

The ability to manage different settings within a organisation is currently limited to the color scheme of the organisation. The admin user can select the color scheme which will apply to all users if they have their own setting as "Same as organisation". The three color schemes are currently "Default", which is a blue theme, "Federal", which follows the guidelines of the gold UAE Federal theme, and "AID", which is a red theme.

There is no current ability to customise the colour scheme as a user. Any requests for a color scheme change would require consultation with the Space42 team. Please use the contact us form to request a new color scheme in the product.

It is worth noting that a user can override the selected color scheme. For example, if the admin user selects "Federal" as the color scheme and the user selects "Default", then that users display will be in the "Default" mode. One user's preference will not affect another users preference.

3. File Manager

The administrator of the file manager is a permission within the file manager section.

The admin has a few extra functions over the normal user of the file manager page. Only an individual with the administrator permission for file manager can do the following functions:

1. Delete a file. Once a file has been deleted it is permanently deleted, together with the model runs and other associated files. As this is a dangerous feature it has been restricted to the administrator permission

2. Edit a file property. Some file properties can be edited. This includes the acquisition date and the location of the file (if this data does not exist in the metadata). As these can be dangerous features it has been restricted to the administrator permission.

3. Download a file. The ability to download a file is currently restricted to the administrator.

An administrator can do all of the above functions to all files within the product. Note: A user who has uploaded a file can make edits, delete and download files that they have uploaded, but can not do these functions to files uploaded by others without the admin permission.

Admin - File Manager

1. Click on File Manager

2. Delete and Download Options

You will now see two options at the bottom of the screen. Note, if a user without admin privileges uploads a file, they also have these actions on the file they have uploaded.

3. Click on delete…

4. Pop-up warning

A warning will popup showing that deleting a file can not be undone. The file will need to be re-uploaded.

5. To change a property which is not automatically detected

If a property is automatically detected, then the property field will not allow for change.

4. Data Acquisition

The is a setting to administer the data acquisition. This allows an organisation to control which orders are approved internally before they pass on to be acquired. As satellite imagery can get expensive, it is vitally important that each organisation can control which users have the authority to approve orders.

For entities with a single user role, it also provides a check for the order prior to it being completed programatically and incurring costs.

The following workflow explains how the administration of a data acquisition works. For further informtaion on how to place an order please consult the relevant user guide.

1. Click on data acquisition

2. Then click on orders

3. This will show the orders from your organisation

There are several items here to keep in mind.

Order number: This number is unique to this order. If you need to contact us about an order you can use this number.

Type: Archive or Tasking. The processing steps could vary depending on the order type.

Status: Pending approval means there is an action required before the order is completed.

4. Actions

We will go into more details about the actions. The orange X is a quick cancel option. be aware that if an order is cancelled it will need to be restarted from scratch.

The arrow. This takes you into the order details page. What happens here varies depending on the order type.

5. Order Details

Here we can track the order progress through the approval channels. In this sample we have the organisation approval, the UAE Space Agency approval and the Space42 Approval.

Organisation approval - this ensures that the budget holder of the organisation approves the order before the order progresses.

UAE Space Agency Approval - If the UAE Space Agency are facilitating your account they will need to approve of the order.

Space42 approval - This is more of an acknowledgement of the order. It shows that for some orders we are now trying to fulfil the order.

6. Click on Approve Order

As this user has the permission, I will approve the order.

# Data with API

First we will look at the API version

7. Order Tracking

We can see how the order tracking is progressing. Note the order can still be cancelled at this stage.

8. Order Acknowledged

Once the order has been acknowledged the system automatically begins downloading the file from the vendor.

# Without API

The flow is slightly different with orders that do not contain an API integrated vendor

9. Order details

Once the order is in progress you can see that the cancellation is no longer available.

10. Fulfillment

The order has moved to the fulfilment stage. This is how the system looks when the data is being uploaded to your organisation.

11. Completion

Once the data has been uploaded, the order is automatically completed.

5. Models

The administrator of the models is a permission within the models permission set.

As a user of the models management page, the only things a user can do is view the models that are active in the system and do some limited functions on models that the user has uploaded.

As an administrator, the user has the ability to configure all of the models in the product, as well as activate or deactivate a model, and select if the model should run automatically or not. The admin user can also configure the category mapping for all of the models within the organisation.

Finally, the administrator can also manage the publishing of a model to the marketplace from this location.

Navigating and Configuring Settings in gIQ for Model State and Categories

1. Click on Models…

2. Click on Configuration…

This configuration allows a user with the correct permissions to state if a model should run automatically when a file is ingested to the system. It is not recommended due to a potential high GPU resource cost, but the option is available.

3. The other configuration options

4. Opens up a panel

From here you can change some of the parameters for running a model.

5. Click on Model State…

This shows if the model should be available for running on your environment or not.

6. To change the category mapping

This feature allows you to map the model label to a category of your choice.

7. Click on Add Category

Or to add a new category!

8. Options

Adding a new category gives you a few options at this stage, such as catgeory color and if it should be a structured diagram.

6. Marketplace

While users can publish marketplace items, it is the responsibility of the administrator to manage the subscriptions - both the subscriptions of the organisation and subscriptions from other organisations.

Within the marketplace page the admin user will see an option for "manage". This will open the seller central. They will see the options of "subscription requests" and "my subscriptions".

Subscription requests show the subscription resquests made by other organisations for the items that your organisation has published. My subscriptions is the page which shows all of the subscriptions that your organisation has made to other entities.

Therefore, several actions on these pages are reserved for the administrator only, such as approve, cancel and reject.