3.8 Spatial Studio Console Page

You can monitor the status and activity of Spatial Studio in the Console Page. You can also view server logs, change global system configurations, manage custom basemaps, and configure safe domains.

The Console menu link directs you to the Console page.

Note:

If you are logged in as an administrator of Spatial Studio, then you can access all the supported Console menu options. Otherwise, you can access only the Map symbols and Access Tokens options under Settings and Security sections respectively.

The layout of the Console page is as shown:

Figure 3-55 Console Page

Description of "Figure 3-55 Console Page"

The Spatial Studio console page comprises of the following sections:

Settings

• General: This slider allows changing the GeoCoding service URL, the geocoding batch size, and the web proxy used by the Studio server. It also allows you to customize the frontend branding area of the application.
• GDAL Installation Info: This slider allows you to verify the GDAL SDK and Oracle Instant Client installations and to view the location path on the server for these installations.
• Safe Domains: This slider allows the administrator to manage the white listing of the domains (host names or IP addresses) that are considered safe for loading various types of the resources from the Studio application. See Managing Safe Domains for more information.
• Basemaps: This slider allows a quick view of the existing custom basemaps, and in adding or editing custom basemaps. Custom basemaps can be made of either raster or vector tiles, typically hosted on a third party tile server. Additionally, you can also create a custom basemap using a WMS OGC web service.
• Cesium Basemaps: This slider gives you a quick view of the existing custom basemaps used exclusively for the 3D Cesium Map visualization. It also allows you to add new basemaps to be used by the 3D Map visualizations.
• Map symbols: This slider allows you to upload custom map symbols in Spatial Studio. This option is available for both Spatial Studio administrators and regular users.

Note:

Each listed host entry for Basemaps and Cesium Basemaps must be present as one of the entries in the Safe Domains list. If the host basemap comes from a domain that is not present in the Safe Domains list, then the basemap may not render correctly when visualizing the map.

Security

• Access Tokens: This slider allows you to create different types of access tokens. This option is available for both Spatial Studio administrators and regular users.

  See About Tokens in Spatial Studio for more information.

• Fileset Tokens: This slider allows you to view the existing fileset tokens and also to create a new fileset token.

  See Generating a Fileset Token for more information.

Maintenance

• Refresh Coordinate System cache: Use this only when needed to rebuild the text index of the repository database schema’s supported Spatial Reference Well Known Text (WKText) definitions. For the shapefile upload, this WKText index is used to automatically match the best SRID.
• Refresh Metadata Cache: Spatial Studio typically caches all of the frequently used metadata such as the definitions of Datasets, Connections, and Projects. Sometimes it is required to refresh the whole cache in case some cached metadata becomes stale or out of sync in rare events.
• Notifications: You can use this option to set up one or more system notifications. These notifications are displayed across the top of the Spatial Studio application once a user logs in.

Monitoring

• Server Status: This section provides read-only information about the general health and system status of the Spatial Studio server.
• Cache Status: This section provides the details of the cache maintained by Spatial Studio.
• Service Logs: This section allows loading and viewing a desired number of server-side logs. To reduce the clutter, you can filter the result using the desired logging level. It also allows the administrator to change the logging level. See Viewing and Managing Server Logs for more information.

In a cluster deployment, both the preceding options display only the information of the particular Spatial Studio instance to which the current session is connected.

• Configuring Custom Branding
  
• Configuring Zip Upload Settings
  
• Configuring Web Proxy
  
• Configuring Service URLs
  
• Uploading a Map Symbol
  
• Managing Safe Domains
  
• Adding a Custom Basemap
  
• Editing a Custom Basemap
  
• Managing System Notifications
  
• Viewing and Managing Server Logs
  
• Viewing GDAL Installation Info
  

3.8.1 Configuring Custom Branding

As a Spatial Studio administrator, you can use the Brand Manager feature in Spatial Studio to upload your brand logo and change the application title as desired.

The following steps enable you to configure custom branding.

1. Navigate to the Console page.
2. Click General under Settings.
   The Brand Manager slider opens as shown.

   Figure 3-56 Custom Brand Configuration

   
   

   
   Description of "Figure 3-56 Custom Brand Configuration"

   
   
3. Select Custom from the Banner style drop-down list.
   The following two banner styles are supported:

   • Default: This is the default configuration which uses Oracle branding.
   • Custom: Custom configuration allows you to apply your organization's branding.
4. Change the Application title as desired.
   The default value is Spatial Studio.
5. Upload your own Application logo.
6. Enter your Application logo name.
7. Preview your changes and click Save Changes.
   Note that you need to refresh your page to see the custom brand changes.

3.8.2 Configuring Zip Upload Settings

Spatial Studio allows you to create datasets by uploading zip files. As a Spatial Studio administrator, you can set the size limits for these zip files.

Perform the following steps, to change the zip upload settings.

1. Navigate to the Console page.
2. Click General under Settings.
   The General slider opens.
3. Click the Advanced Settings collapse icon to open the Zip Upload Settings as shown:

   Figure 3-57 Zip Upload Settings

   
   

   
   Description of "Figure 3-57 Zip Upload Settings"

   
   
4. Change any of the following default configuration options as required.
   • Maximum inflate multiplier: Maximum allowed multiplier when inflating files.
   • Maximum unzipped item size (MB): Maximum size for an item in the zip file.
   • Maximum unzipped total size (MB): Maximum size of the zip file (with all the entries unzipped to the disk).
5. Click Save Changes.

3.8.3 Configuring Web Proxy

If the Spatial Studio server is running behind a fire wall, then you can configure a web proxy server in your web application.

Note that the web proxy settings only affect the backend Java server when it needs to access an external service or data source through HTTP. One such example is the Oracle Maps cloud services used to geocode the addresses in a dataset. If Spatial Studio is running behind a firewall then the web proxy settings will be used to access the Oracle Maps services which run on the public internet.

Perform the following steps to configure a web proxy server.

1. Navigate to the Console page.
2. Click Proxy under Settings.
   The Proxy slider opens as shown:

   Figure 3-58 Web Proxy Configuration

   
   

   
   Description of "Figure 3-58 Web Proxy Configuration"

   
   
3. Switch ON the Use Proxy slider.
4. Enter the Proxy Server details.
5. Enter the Proxy Server Port.
6. Optionally, enter the Non-Proxy Hosts.
7. Optionally, switch ON the Proxy Requires Login toggle if it applies and provide the Proxy User Name/Proxy User Password credentials.
8. Click Save Changes.

3.8.4 Configuring Service URLs

In order to perform geocoding and routing tasks, you can configure the URL for these services in Spatial Studio if you are an administrator user. You can choose to replace the default URLs with your own service URLs.

1. Navigate to the Console page.
2. Click Services under Settings.
   The Services slider opens as shown:

   Figure 3-59 Service URLs Configuration

   
   

   
   Description of "Figure 3-59 Service URLs Configuration"

   
   

   The default geocoding and routing service URLs are as shown in the preceding figure.

3. Optionally, change the default URLs for any of the following services as required.

   Geocoding Service

   1. Click the Geocoding Service drop-down and select Custom.
   2. Enter your own Geocoding Service URL.
   3. Change Geocoding Batch Size if required.
   4. Click Test to verify your connection.

   Routing Service

   1. Click the Routing Service drop-down and select Custom.
   2. Enter your own Routing Service URL.
   3. Click Test to verify your connection.
4. Click Save Changes.

3.8.5 Uploading a Map Symbol

You can upload custom map symbols (or icons) and also 3D models (in .glb format), which you can use in a Map or Cesium-Map visualization. Starting from Spatial Studio Release 24.1, in addition to administrators, all valid Spatial Studio users can also upload and manage their own custom map symbols.

Also, note the following:

• All uploaded symbols are assigned a globally unique ID. The application always references the symbol using its unique ID, and not by its name. The name of the symbol is used only for display purposes in the application.
• When a regular user (non-administrator) uploads a map symbol, the symbol is visible and accessible only for that specific user and does not become public.
• When an administrator uploads a map symbol, the symbol is accessible in a read-only manner to everyone in the organization. The symbol will show up in the symbol list of any regular Spatial Studio user along with their own symbols.
• Regular users can Rename and Delete only their own custom map symbols.
• If two different users upload an image file with the same name, then the symbols do not get overwritten as each symbol is referenced by its unique ID.
• When an owner attempts to delete a custom map symbol, Spatial Studio performs a referential check to ensure that the particular symbol is not used in any map visualization.
• The Copy symbol ID option can be used when the user wants to explicitly assign and apply different custom symbols to different groups of data, in which case the symbol ID needs to be stored in the source data table in its own column.

The following steps enable you to add a custom map symbol in Spatial Studio.

1. Navigate to the Console page.
2. Click Map symbols under Settings.
   The Map symbols slider opens as shown.

   Figure 3-60 Uploading a Map Symbol

   
   Description of "Figure 3-60 Uploading a Map Symbol"
3. Click the Custom symbols collapse icon and click Upload symbol.
4. Select the required image file in your system for the upload.
   It is important to note the following:

   • Only .png, .gif, .jpg, and .glb file formats are supported.
   • Each file cannot exceed 2 MB in size.
5. Optionally, change the Symbol name.
6. Click to add the custom map symbol.
   Once it is uploaded, you can style your data points on a map visualization using the new symbol. See Applying Custom Map Symbols to a Map Layer for more information.

3.8.6 Managing Safe Domains

As an administrator, you can add a domain of a custom basemap or a WMS service to the Content Security Policy directives of your Spatial Studio application.

Alternatively, you can edit or delete an existing safe domain.

Note:

If you make any changes to the safe domains list, then it is important that you refresh or reload the browser page to reload the new Content Security Policy.

1. Navigate to the Console page.
2. Click Safe Domains under Settings.
   The list of safe domains to which Spatial Studio has access is displayed as shown:

   Figure 3-61 Safe Domains

   
   Description of "Figure 3-61 Safe Domains"

   You can choose to perform one of the following actions:

   • Adding a safe domain
     1. Click Add.

        A new row gets added to the end of the safe domains table list.

     2. Double-click the Domain Name cell of the empty new row to enter the new domain.

        Ensure that you enter only the domain part of an external URL (that is, the protocol, host name or IP address, and port) from which you will be fetching the resources. For instance, https://wms.mycompany.com:8080 or https://wms.mycompany.com.

        Note that the protocol is a part of the domain and should be based on the URL of the remote service. For instance, if you defined a WMS data source or a custom base map in Spatial Studio, and the URL to the WMS server or the custom base map's tile server starts with https://, then you must use https://. If it starts with http://, then use http://. In case if both the protocols are used (maybe one is used to fetch some resources while the other is used for a different type of resource), then you need to add the domain twice, one with the http:// protocol and another with the https:// protocol. Spatial Studio performs safe domain validation strictly based on the value you added to the list.

     3. Select the appropriate check boxes.

        The check boxes represent Content Security Policy fetch directives.

        • Connect: This corresponds to the CSP connect-src directive, and indicates whether Spatial Studio is allowed to interact with the domain via script interface (such as AJAX calls).
        • Image: this corresponds to the CSP img-src directive, and indicates whether Spatial Studio is allowed to fetch images from the domain.
        • Script: this corresponds to the CSP script-src directive, and indicates whether Spatial Studio is allowed to import or load scripts hosted by the specified domain.
        • Font: this corresponds to the CSP font-src directive, and indicates whether Spatial Studio is allowed to load font data from the specified domain.
        • CSS Style: this corresponds to the CSP style-src directive, and indicates whether Spatial Studio is allowed to load stylesheet from the specified domain.

        It is important to understand what type of resources you will be fetching from the specific domain. For instance, if you select the check box Script, then it implies that you are enabling your browser to fetch Java Script type resources from the domain.

        In case if you are adding a safe domain for a WMS data source, then you likely need to enable the following check boxes:

        • Connect: This is required because Spatial Studio needs to interact with a remote WMS data source to check its capabilities using AJAX calls.
        • Image: This is needed because eventually Spatial Studio needs to fetch individual WMS map images from the remote WMS server.

        Note that when a check box is selected, the domain URL gets added to a list of all the allowed URLs for the corresponding CSP directive. For instance, consider that the domain https://www.mycompany.com is added as a safe domain with the Connect check box selected. Then, when you reload Spatial Studio, the CSP header loaded by the browser will now include https://www.mycompany.com in its connect-src directive's list of domain values.

     4. Click Save Changes.
     5. Ensure to refresh or reload the browser page.
   • Editing a safe domain
     • Double-click the required safe domain table row and edit the required details.
     • Click Save Changes.
     • Ensure to refresh or reload the browser page.
   • Deleting a safe domain
     • Double-click the required safe domain row in the table.
     • Click and confirm delete by clicking OK.
     • Click Save Changes.
     • Ensure to refresh or reload the browser page.

3.8.7 Adding a Custom Basemap

The following steps enable you to add a custom basemap.

1. Navigate to the Console page.
2. Click Basemaps under Settings.
   The Basemaps window listing all the available basemaps opens.
3. Click Add Basemap and click on one of the following basemap types:
   • XYZ Raster tiles
   • OGC WMS
   • Vector tiles
4. Enter Name and URL for the selected basemap type.
5. Optionally enter Attribution and API Key.

   Tip:

   Once you have entered all the required fields, you can preview the basemap by clicking Quick View.
6. Click Save to add the base map.
   For example, the following figure show the OGC WMS basemap configuration window:

   Figure 3-62 Adding a OGC WMS Map

   
   Description of "Figure 3-62 Adding a OGC WMS Map"

   Note:

   It is important to add the domain name to Safe Domains in order to enable the Spatial Studio application to access the required service for the basemap.

3.8.8 Editing a Custom Basemap

The following steps enable you to edit a custom basemap.

1. Navigate to the Console page.
2. Click Basemaps under Settings.
   The Basemaps window listing all the available basemaps opens.
3. Click against the required custom basemap and click Edit from the context menu.

   Note:

   Edit is disabled for predefined Spatial Studio maps.

   The custom basemap configuration details are displayed for editing as shown:

   Figure 3-63 Editing a Custom Basemap

   
   Description of "Figure 3-63 Editing a Custom Basemap"
4. Modify the required parameters, such as Name, Attribution, URL or API Key.
5. Click Save.
   The custom basemap details are modified and the updates are shown in the Basemaps window.

3.8.9 Managing System Notifications

As the Spatial Studio administrator, you can create, edit, or delete system notifications.

Spatial Studio supports two types of notifications:

• Banner: These notifications are typically used to display informative message such as planned downtime, scheduled updates, and so on. Banner type notifications are displayed across the top of the web application page, just above the built-in Spatial Studio application banner.
• Show Stopper: These are messages that will be displayed when the Spatial Studio server is not servicing any requests such as when being investigated for emergency issues or breaches.

You can manage the system notifications as shown in the following steps:

1. Navigate to the Console page.
2. Click Notifications under Maintenance.
   The Notifications window listing all the configured notifications opens.

   Figure 3-64 System Notifications

   
   Description of "Figure 3-64 System Notifications"
3. Perform any one of the following required actions.
   • Create a New Notification
     1. Click Create.
     2. Select the Notification Type.
     3. Enter Severity, Expiration Date (in UTC), and Message for banner notifications.
     4. Enter Title, Expiration Date (in UTC), and Message for show stopper notifications.
     5. Click OK.

     The new notification appears in the Notifications dialog.

   • Edit a Notification

     Click against a notification to edit the message details.

   • Delete a Notification

     Click against a notification to delete the notification.

3.8.10 Viewing and Managing Server Logs

You can always view the most recent log messages generated by the server in your Spatial Studio application.

Perform the following steps to view and manage these server logs.

1. Navigate to the Console page.
2. Click Service Logs under Monitoring.
   The Service Logs slider opens as shown.

   Figure 3-65 Service Logs

   
   Description of "Figure 3-65 Service Logs"
3. Optionally, configure any of the following fields to customize the logs that are fetched from the server.
   • Total entries: This limits how many log messages or records will be loaded from the server.
   • Crop entries: If switched ON, then any log message with a very long string will be cropped when viewed.
   • Entries’ length: This determines the crop length.
   • Filter by log level: This drop-down list allows you to filter the server logs so that only those logged at the selected level or higher (more severe in nature) will be fetched from the server for display.

     The supported log levels are:

     • ERROR
     • WARN
     • INFO
     • DEBUG
     • TRACE
   • Load Logs: Click this button to reload the logs from the server when you change any of the preceding configurations.
4. Optionally, click Change Logging Level to change the server's logging level.
   Change Logging Level window opens as shown.

   
   Description of the illustration change_log_level.png

   The Change Logging Level button allows the administrator user to dynamically change the logging level used by the server without restarting it.

   Sometimes it may become necessary to change the logging level, so that the Spatial Studio server can log more or less messages, or generate DEBUG or TRACE level messages for a specific functional area in order to diagnose a certain issue. By default, Spatial Studio uses the INFO log level, which means only log messages generated at the level INFO, WARN, or ERROR will be written to the log file (default location is <OS_USER_HOME_DIR>/.sgtech/logs/sgtech.log).

   1. Optionally, change any of the following configuration.
      • Package name: This specifies the area of the server that will be affected by the new logging level. If you specify ROOT (the default value), then the new logging level will affect all areas or functions of the Spatial Studio server. However, you can also enter a specific Java package name (maybe based on suggestions from your Oracle Support team), such as oracle.sgtech.jee.api when debugging issues related to Spatial Studio instance’s REST API end points. When a specific package name is entered, then the new log level will only take effect when code from that package is executed.
      • New Log Level: This drop-down list allows you to select the new log level to be applied to the server’s specific package or the entire server (default ROOT).
   2. Click OK.
      Note that the log files may take a while to be filled with the messages logged at the new level.

3.8.11 Viewing GDAL Installation Info

In order to upload raster imagery from files into the database, Oracle Instant Client and GDAL SDK needs to be configured correctly in Spatial Studio. You can verify if these installations are successful and view the location of these installations on the Console page.

Perform the following steps to view the GDAL installation info.

1. Navigate to the Console page.
2. Click GDAL Installation Info under Settings.
   The GDAL Installation Info slider opens as shown.

   Figure 3-66 GDAL Installation Info

   
   

   
   Description of "Figure 3-66 GDAL Installation Info"

   
   

   Depending on whether the GDAL SDK and Oracle Instant Client installations exist or not, the corresponding message Found or Not Found is displayed.