Skip to main content
Close
Hitachi Vantara Knowledge

Administering domains

  1. Last updated
  2. Save as PDF

The article describes the concept of domains in Hitachi Visualization Suite and how to configure domains to create instances of Visualization Suite using the admin portal.

Parent Topic
  • Administration Guide

    The guide gives an overview of product features and related technologies. In addition, it contains recommendations on best practices, tutorials for getting started, and troubleshooting information for common situations.

Child Topics

Overview

Domains are dedicated, independent Visualization Suite instances for specific users. You can create multiple domains, each configured to meet organization’s unique requirements.

A map server is configured for each domain to show useful data, such as traffic or terrain, from within Visualization Suite. While Visualization Suite uses Google Maps as the default map and geocoding and reverse geocoding services, it supports custom map configurations allowing you to set up a domain with the existing Esri ArcGIS server. Configuring Visualization Suite with a map server running on a private network gives Visualization Suite with added security and availability.

Parent Topic

Logging in to the admin portal

You can create domains and manage domain settings using the admin portal. You need the administrative privilege to access the admin portal. The login credential was created during the installation.

Procedure

  1. Go to https://portal.<your-HVS-host-instance>.com

  2. Log in to the admin portal.

    Visualization Suite Admi n Portal Login Window
Parent Topic

Domain configuration

When you add a domain, you will use the DOMAIN configuration page, as shown in the following example.

Visualization Suite Admin Portal Site, Domain Section.

The following table describes the settings within the DOMAIN configuration page.

ItemDetails
NameThe name of the Visualization Suite instance you want to create (example: Gotham Police Department).
DNSThe name of the domain in the URL (for example, gothampd.nnn.com).
User NameThe name of the domain administrator. After a domain is created, the User Name cannot be changed.
EmailThe email address of the domain administrator. After a domain is created, a Visualization Suite account activation email is sent to the account. If the account is not activated within the specified period, click the forgot password link of the login window for the new domain. After a domain is created, the email cannot be changed.
ReferrerThe name of the administrator who emailed a request to create a domain. Either the user name or email of the administrator can be specified as the referrer.
NotesA summary of facts, topics, or thoughts that relate to the domain, such as domain usage.
Time ZoneSpecifies time zones for time stamps and date preferences in Visualization Suite.
Enable DomainSelec the check box to enable the domain upon its creation.
Enable Flash/Disable DashSelec the check box for Visualization Suite to use Flash Player (Flowplayer). If left un verified, Visualization Suite uses the DASH video player (the default player).
Use Port 554 for RTSP Video StreamingSelec the check box to use port 554 for RTSP video streaming. By default, Visualization Suite uses port 80 for RTSP video streaming. Note that enabling this option requires the Wowza Stream Engine configurations to be updated. For more information, see Managing Traffic Over Port 554.
Enable 8×8 VideowallSelec the check box to enable the 8×8 videowall layout. The 8×8 is disabled by default as additional hardware requirements might apply to ensure optimal viewing experience. Contact the Visualization Suite Sustaining Team for more information about the requirements.
Enable HVS Managed GatewaySelec the check box to use Visualization Suite Managed Gateway for configuring VMS. Checking this option enables you to select the managed gateway during a VMS setup. You can use your own gateway or the managed gateway. See Administering gateways to learn more about this feature.
Enable Audit Retention ManagementSelec the check box to enable audit retention management. Checking this option allows you to configure retention rules for audit data generated by Visualization Suite. Otherwise, if this option is disabled, audit data grows excessively, causing the server to run out of disk space.
Video TechnologySelect the Media Server you want to use. This setting is not applicable to Video Management System (VMS) vendors that include a media server, for example Hitachi Video Management Software (HVMS), Hitachi Video Management Software Base (HVMS base), Kastle, and Videonetics. Select Hitachi Streaming Media Server - DASH for low latency and quick start streaming time without the Flash player plugin.
  • Hitachi Streaming Media Server - DASH
  • Wowza Streaming Engine - DASH
  • Wowza Streaming Engine - Adobe Flash
    NoteFlash Player End-Of-Life (EOL) is December 31, 2020.

For how to use Hitachi Streaming Media Software, see Administering Media Server.

Audit Retention Period in DaysSpecify the number of days (up to a maximum of 60 days) for which Visualization Suite collects audit data. Note that after the specified timeframe, the data is overwritten to create space for new data. However, for an Visualization Suite deployed within a user's own environment, you can set a longer retention period by scaling server storage space. For more information, see the Installation Guide (this article require special permissions).
Search Result Limit per Entity TypeSpecifies the max number of search results displayed for each entity type. The default is 10. This function can be used to curtail results to keep search "less noisy" especially if you have a large number of events, cases, and objects in the domain. For example, if there are 10,000 assaults in a domain and typical searches find 300 hits on average, you can show just the top 20 results by setting the upper limit to 20. If you don't want an upper limit, specify a large number such as 100,000.
Locate Icon Zoom LevelSpecifies the zoom level for showing an event, object, or case on the map in an exploded view. The default is 18. From the search result or alert pane, a user can view an event on the map by clicking on the Go to icon. This shows the event on the map at a predefined zoom level. The zoom level between 3 (the lowest zoom level available in which a continent can be seen on one map) and 21 (streets and buildings) are possible within the default roadmap view. The default is 14. The following list indicates the approximate detail you can expect to see at each zoom level:
  • Zoom level 3: Continent
  • Zoom level 5: Landmass
  • Zoom level 10: City
  • Zoom level 15: Streets
  • Zoom level 20: Building
Upload Access Token Lifetime in MinutesSpecifies the access token lifetime (in minutes). You can change how long the security token created by Visualization Suite is valid by entering a different value here.
Map ServerSelect the map server you want to use. Note that without a connection to the map server Visualization Suite still runs, but map services will not be available. The default setting is Google Maps. Select Esri ArcGIS to set up a custom map server. For Esri ArcGIS, the server provides the following settings:

  • Server Address

    Defines the URL to the map server. This can be a publicly available map server, or a privately configured server.

  • Base Map Endpoint

    Specifies the underlying ArcGIS basemap type for Visualization Suite. Examples include a topographic map, terrain with labels, or a more detailed city street map. URL format example (the zoom level z and x and y are the coordinates): /ArcGIS/rest/services/world_topo_map/MapServer/tile/{z}/{y}/{x}

  • Latitude and Longitude

    Specifies the starting latitude and longitude for the domain. Users can override the settings in their account preferences.

  • Geocode endpoint

    Specifies the directory to point to the geocoding service on the map server.

Maximum Audit Period (in Days)Specifies the maximum number of days for which Visualization Suite allows users to download audit reports (maximum 7 days). Visualization Suite puts two types of limits on the report download size:
  • the maximum audit period (in days)
  • the number of audit entries per request
The download size is determined by whichever condition that reaches its limit first. For example, if the maximum audit period is set to 7 days but Visualization Suite recorded 12,000 user operations in the first day of that period, Visualization Suite only allows downloading of the first 10,000 user operations even though it is only one day worth of data.
Audit Report Record Limit per RequestSpecifies the maximum number of audit entries that can be downloaded in a single request (maximum 10,000 entries).
Audit CSV Rows per FileSpecifies the number of rows to be included in each CSV file output (default 5,000 rows).
Custom Dashboard Server AddressThe base address for the Pentaho server that Visualization Suite uses to connect to Pentaho.
Custom Dashboard Report PathFolder path for publishing custom reports. All reports that are created using Pentaho and are placed in this folder will be published to Visualization Suite.
Parent Topic

Adding a domain

Use the DOMAIN configuration page to add a domain. The domain administration page shows a list of domains on the left. The domain configuration details for the selected domain are shown on the right side of the window. Within a domain, you can configure settings for map, audit, search, and other Visualization Suite features and add licenses.

See the table related to Domain Configuration for information about each setting.

Procedure

  1. On the admin portal home click New +.

    The DOMAIN configuration page opens.

  2. Under DOMAIN, enter the required information for the domain.

  3. Click Save to save the configurations and exit Visualization Suite so that the changes take effect.

  4. To verify the changes, log in to Visualization Suite and confirm that the newly configured map is shown in all pages for the domain.

Parent Topic

Adding a license

When a domain is added, you can add a license to that domain.

Procedure

  1. On the admin portal, select the domain for which a license is added.

  2. Scroll down to the LICENSES section.

  3. Click Add new License and provide the license ID and the expiration.

  4. Select the module types (all that apply).

    • Archive
    • Predictive Crime Analytics
    • Custom Dashboards

  5. Optionally, provide the name of the license.

  6. Click Save to save the license information.

GUID-78EE9AAA-2E85-42CE-B89A-4C6B33C6D332-low.png
Parent Topic

Adding a Pentaho instance

After you have added a domain and license, you can add one or more Pentaho dashboard instances for that domain.

GUID-A9C33DF2-19D2-4603-929D-452C30EEAFDC-low.png

Procedure

  1. From the admin portal, select the domain for which must add a license.

  2. Locate the PENTAHO section.

  3. Click Add new Pentaho. The PENTAHO configuration page opens.

  4. Enter the required information for the Pentaho instance:

    1. Name - The text that displays within the Dashboard menu in Visualization Suite. For example, Smart Energy Dashboard or Smart School.

    2. Server Address The Pentaho server base address that Visualization Suite uses to connect to Pentaho. The address must include the http or https protocol, for example: https://dashboard_url.com/pentaho.

    3. Report Path The Folder path in which Pentaho reports are published. All reports that are created using Pentaho and are placed in this folder and published to Visualization Suite. For example, /home/PENTAHO_USER_NAME/report_path

      PENTAHO_USER_NAME The name of the Pentaho user who has a minimum of read access to the report path. The user name is case sensitive and it should be the hvsPrincipal value in the applicationContext-HVS-SSO.xml file.

    4. Expiration - The date that the access to the Pentaho server expires (Pentaho license expiration).

  5. Click Save to save the license information.

Parent Topic

Modifying a Pentaho instance

You can change information about a Pentaho instance.

Procedure

  1. In the Pentaho section, locate the Pentaho instance.

  2. Click the more option (3 vertical dots) of the Pentaho instance.

  3. Select the Edit menu, then modify the Pentaho instance information as needed.

  4. Click Save to save the changes.

Parent Topic

Deleting a Pentaho instance

When you remove a Pentaho instance, it is removed from the Visualization Suite dashboard menu.

You can permanently remove a Pentaho instance by clicking the more option (3 vertical dots) of the Pentaho instance to be removed, then selecting Delete.

GUID-CC627569-DCBB-4C78-BC18-2E9DB2DABC7C-low.png

Procedure

  1. In the PENTAHO section, locate the Pentaho instance.

  2. Click the more option (3 vertical dots) of the Pentaho instance.

  3. Click Delete.

  4. Click Confirm to confirm the removal of the instance.

    NoteWhen an instance is removed, the dashboard menu in Visualization Suite will no longer include it. If needed, click Cancel to cancel the deletion.
Parent Topic