Table of Contents
Last updated: 2024-11-14

3D Viewer component installation

Note
  • Using the 3D Viewer components requires a separate license in addition to the ShareAspace license.
  • The file preview component and the single component Web 3D viewer are both agnostic to the ShareAspace configuration used by a space however viewing non-monolithic assemblies in the web 3D viewer requires a configuration based on the predefined ShareAspace information capabilities.

Components

Component Installation package Description
Web 3D Viewer 3DViewer-x.y.z.bbb.msi External extension web module for 3D viewing of single geometry as well as full geometry assemblies.
CAD converter CadConverter-x.y.z.bbb.msi ShareAspace Nova extension that provides two features. 2D file preview of supported formats. Light weight 3D preview conversion of supported formats and caching of light weight files. Conversion is executed when a file is created in the managed file vault of a space (through API and import).
Streaming cache service StreamingCacheService-x.y.z.bbb.msi Server side component for generating 3D viewing models and providing these to clients (web browsers) via a web socket stream.
HOOPS Communicator HOOPS_Communicator_2024.1.0_Windows.zip Installation package for HOOPS Communicator from Tech Soft 3D, see HOOPS Communicator.

Prerequisites

Web 3D Viewer
1 Operating System (OS) Microsoft Windows Server 2022
2 Operating System Features Web Server (IIS) Role
3 Web Management Tools
4 TLS Certificate (for IIS) see TLS Certificates section

CAD converter
1 Operating System (OS) Microsoft Windows Server 2022
2 Operating System Features Web Server (IIS) Role
3 Web Management Tools
4 .NET Core Hosting Download and install ASP.NET Core Runtime 8.0.6 Hosting Bundle
5 TLS Certificate (for IIS) see TLS Certificates section
6 HOOPS Communicator 22.2.1.0

Streaming cache service
1 Operating System (OS) Microsoft Windows Server 2022
2 Operating System Features Web Server (IIS) Role
3 Web Server / Application Development / WebSocket Protocol
4 Web Management Tools
5 .NET Core Hosting Download and install ASP.NET Core Runtime 8.0.6 Hosting Bundle
6 TLS Certificate (for IIS) see TLS Certificates section
7 HOOPS Communicator 22.2.1.0

HOOPS Communicator 22.2.1.0
1 Operating System (OS) Microsoft Windows Server 2022
2 Visual C++ redistributable Download and install Visual C++ 2015-2022 64-bit redistributable
4 License A valid HOOPS Communicator license key.
Note

Read more about the HOOPS pre-requisites here: https://docs.techsoft3d.com/communicator/latest/build/overview/supported-platforms.html.

Installation

Web 3D Viewer

  • Run installer 3DViewer-x.y.z.bbb.msi.
  • The default installation location is C:\Program Files\Eurostep\ShareAspace\3DViewer.
  • Running the MSI deploys an IIS web application 3DViewerWeb and an application pool 3DViewer.

CAD converter

  • Run installer CadConverter-x.y.z.bbb.msi.
  • The default installation location is C:\Program Files\Eurostep\ShareAspace\CadConverter.
  • Running the MSI deploys an IIS web application CadConverter and an application pool CadConverterPool.

Streaming cache service

  • Run installer StreamingCacheService-x.y.z.bbb.msi.
  • The default installation location is C:\Program Files\Eurostep\ShareAspace\StreamingCacheService.
  • Running the MSI deploys an IIS web application StreamingCacheService and an application pool StreamingCacheServicePool.

HOOPS Communicator

  • Unpack the HOOPS_Communicator_2024.1.0_Windows.zip ZIP archive. e.g. at C:\HOOPS_Communicator_2024.1.0.
  • Create a license.txt file and paste the license key to it. e.g. at C:\HOOPS_Communicator_2024.1.0\license.txt.
  • Setup work folders for file conversion and storage folder for conversion cache. Preferably on a specific storage drive. e.g.
    • F:\3dviewer\model\.
    • F:\3dviewer\temp\.

Configuration

For the configuration examples in this section it is assumed that

  • The 3D viewer components are hosted at the fictive address https://xyz.eurostep.com.
  • The HOOPS Communicator ZIP archive is extracted at C:\Program Files\Eurostep\Hoops\.\
  • The HOOPS Communicator license is placed at C:\Program Files\Eurostep\Hoops\license.txt.
  • There is a separate drive F:\ for caching converted files.

Web 3D Viewer

  • Open the config.json file found at the root of the web 3D viewer installation location. (Default C:\Program Files\Eurostep\ShareAspace\3DViewer\config.json).
  • Set the ServerURL parameter.
Parameter Description
ServerURL Should point at the deployed web application for the streaming cache server. 
{
    "ServerURL": "https://xyz.eurostep.com/StreamingCacheService/",
    "ClientTimeout": 20,
    "ClientWarning": 15
}

CAD converter

  • Open the appsettings.json file found at the root of the web 3D viewer installation location. (Default C:\Program Files\Eurostep\ShareAspace\CadConverter\appsettings.json).
  • Set the SymmetricKey, LicenseFilePath, ConverterExecutablePath, OutputPath, and TempDirectory parameters.
Parameter Description
SymmetricKey A unique API key for the REST API hosted by the CAD converter. This key must be provided when registering the CAD converter as a ShareAspace extension. See generate symmetric signing keys.
LicenseFilePath Full filename of the HOOPS Communicator license file. Note: There must not be any spaces in the file path.
ConverterExecutablePath Full filename of the HOPPS Communicator converter executable. Note: There must not be any spaces in the file path.
OutputPath Converted file output path. Note: There must not be any spaces in the file path.
TempDirectory Temporary file conversion directory path. Note: There must not be any spaces in the file path.

Example:

{
  ...
  "NovaConfig": {
    "SymmetricKey": "R1y/zdImRU2/3Uvqr...xbWUnpS5JiPzFLHIoQ==",
    "LicenseFilePath": "C:\\HOOPS_Communicator_2024.1.0\\licence.txt",
    "ConverterExecutablePath": "C:\\HOOPS_Communicator_2024.1.0\\authoring\\converter\\bin\\win64\\converter.exe",
    "OutputPath": "F:\\3dviewer\\model",
    "TempDirectory": "F:\\3dviewer\\temp",
    "LogConverter": true
  }
}

Streaming cache service

  • Open the appsettings.json file found at the root of the web 3D viewer installation location. (Default C:\Program Files\Eurostep\ShareAspace\StreamingCacheService\appsettings.json).
  • Set the StreamCacheServerExecutablePath, LicenseFilePath, ModelDirectoryPath, ConverterExecutablePath, HoopsVersion, and ApiEndpoint parameters.
Parameter Description
StreamCacheServerExecutablePath Full filename of the HOOPS Communicator stream server executable. Note: There must not be any spaces in the file path.
LicenseFilePath Full filename of the HOOPS Communicator license file. Note: There must not be any spaces in the file path.
ModelDirectoryPath Converted files cache folder. Same as the OutputPath of the CAD converter.
ConverterExecutablePath Full filename of the HOPPS Communicator converter executable. Note: There must not be any spaces in the file path.
HoopsVersion The HOOPS Communicator version.
EnableCaching Enables the caching of master models (monolith models) in the streaming cache service. Default value is false.
ApiEndpoint The public facing address of the streaming cache service. 
{
  ...
  "Settings": {
    "StreamCacheServerExecutablePath": "C:\\HOOPS_Communicator_2024.1.0\\server\\bin\\win64\\ts3d_sc_server.exe",
    "LicenseFilePath": "C:\\HOOPS_Communicator_2024.1.0\\licence.txt",
    "ModelDirectoryPath": "F:\\3dviewer\\model",
    "ConverterExecutablePath": "C:\\HOOPS_Communicator_2024.1.0\\authoring\\converter\\bin\\win64\\converter.exe",
    "LogConverter": true,
    "LogStreamCacheServer": true,
    "WebSocketBasePort": 55000,
    "MaxSpawnCount": 10,
    "BackgroundWorkerCapacity": 5,
    "HoopsVersion": "24.2.0",
    "WebSocketActivityTime": 300,
    "StreamCacheTickTimeout": 5,
    "EnableCaching": false,
    "ApiEndpoint": "https://xyz.eurostep.com/StreamingCacheService/"
  }
}

ShareAspace deployment

Web 3D Viewer

The Web 3D viewer must be registered as a Trusted external endpoint.

Parameter Example value Note
Extension URI https://xyz.eurostep.com/3DViewerWeb Hosting address of the 3D viewer.
Id 3DViewer Client configuration in space template must use the id defined here.
Category Client Must be set to Client.
Method GET Must be set to GET.

CAD converter

The CAD converter is registered as a Nova extension.

Parameter Example value Note
Extension URI https://xyz.eurostep.com/CadConverter Hosting address of the CAD converter.
API Key R1y/zdImRU2/3Uvqr...xbWUnpS5JiPzFLHIoQ== The API key configured for the SymmetricKey parameter in the appsettings.json of the CAD converter component.