Skip to main content

Icons Management

Set up displaying icons for different instrument types

Y
Written by Yuxi Liu
Updated over a week ago

Introduction

The Icons management section allows users to upload, edit, enable/disable, and manage icons for specific instrument types in the system. The page is equipped with features to streamline the process, including batch uploads and inline editing.

To access this page: Click on the top left corner to open the side bar, click on ‘Settings’ - 'Files and Attachments' - 'Icon Management' to access the page.


1. Overview of Icon Management Page

The Icon management page contains a list of icons that can be customized and uploaded to this project. Those uploaded icons can be used to define the icon for different instrument types (apart from the system default icons), which will be displayed on the map view for better visualization purpose, for example.

The Fields in the icon page can be explained in the following:

  • Name: The file name of the icon set in this system.

  • URL: The file name of the uploaded icon file.

  • Icon: A visual representation of the uploaded icon.

  • Is Model: N/A.

  • Enabled: Shows whether the icon is active and selectable in the system (e.g., "✓" or "✗").

  • Notes: Additional information about the icon (e.g., context or usage instructions).

  • Updated By: The email address of the user who last modified the icon entry.

  • Updated On: The timestamp of the last modification.

  • Model Rotation: N/A.

  • Created By: Show the email address of the person who created this icon. This function is hidden by-default. Click on the Column Chooser ‘’ and drag the field into the icons table to view more information.

  • Created On: Show the timestamp when the person created this icon. This function is hidden by-default. Click on the Column Chooser ‘’ and drag the field into the icons table to view more information.


2. Key features – Icon Batch Upload / Create / Edit / Disable / Delete

1) Batch Upload multiple icons at one time

The Batch Upload feature allows users to upload multiple icon files at once. This is useful for bulk updates or when setting up a new instrument set.

Step 1: Click the "Batch Upload" button.

Step 2: Select multiple icon files from your device.

Step 3: Review and confirm the upload.

2) New Button to Create a New Icon

The New button lets users add a new instrument icon entry manually.

Step 1: Click the "New" button.

Step 2: Fill in the required fields:

  • Icon Name: Enter the file name of the icon.

  • Notes: Add additional context or information about the icon.

  • Icon/Model File: click on this button to browse and upload the icon file.

  • Is Model: N/A.

  • Disabled: Tick to disable the use of this icon. Untick to enable it.

Step 3: Click "Create" to add the new icon.

3) Edit Existing Icons

The Edit function enables users to modify details of existing icons.

Step 1: Tick to select an existing icon item from the table.

Step 2: Click the "Edit" button.

Step 3: Update fields such as Icon Name, URL image file (by clicking on the ‘Icon/Model File’ button), Notes, or Disable to make any necessary changes.

Step 4: Click "Save" to apply changes.

4) Enable/Disable Icons

The Enable/Disable function allows users to activate or deactivate icons as needed.

Step 1: Tick to select the icon from the icon table.

Step 2: Click the "Disable" button to deactivate it.

Step 3: If need Enable the icon, please click on ‘Edit’ button to Untick the ‘Disable’ box.

5) Delete Icons

The Delete function allows users to delete icons as needed.

Step 1: Tick to select the icon from the icon table.

Step 2: Click the arrow to expand the action bar, and click on ‘Delete’ to delete the selected icon.


3. Instrument Icon Applications by Admins from Global, Tenant, and Project Level

The purpose of setting up icons on the Icon Management Page is to provide available icons for different instrument types, so suitable icon can be configured when create / edit an instrument type, and it can be displayed and represent the instrument type in the report / map view / etc.

The image above shows the general steps of configuring the icon for an instrument type:

Step 1: Navigate to ‘Setting – Instrument – Instrument Types’ page, click ‘New’ to create a new instrument type or tick on an existing instrument type and click ‘Edit’ to open the editing dialog.

Step 2: Click on the Icon to open the drop-down list, and an Icon list is displayed with three sections called ‘Global Icons’, ‘Tenant icons’, and ‘Project Icons’:

  • Global Icons: Icons are set in admin-controlled global level, and the icons are available across all the tenants and projects.

  • Tenant Icons: Icons are set in admin-controlled tenant level, and the icons are available across all projects within this tenant only (the tenant that this project belongs to).

  • Project Icons: Icons are set on the Icon Management Page of this project (instructed in this manual), and the icons are available within this project only.

Step 3: Select the suitable icon for the instrument type and click on ‘save’. If no suitable icon is available, please go to the Icon Management Page to upload a suitable icon.


Did this answer your question?