Chapter goals

In this chapter you will learn the basics on how to install and setup widget box pro (tvc helium widgets), deploy a first widget (included template) and make some basic modifications to it. You will also learn how to find documentation & examples, download binaries & license.

Prerequisites

Access to a 3DEXPERIENCE dev env (tomee 3dspace exploded web app)
Basic xml understanding

Installation

The installers adds web resources to 3dspace and an optional schema (required for live UI configuration etc). The web resources includes jar files, js, html, css etc. A servlet is registered with the web.xml.

TECHNIA best practice project setups uses Gradle and Maven artifacts to build 3dspace web archive. This makes upgrades as easy as changing version in a property file and manual steps are avoided.

Exercise 1 - Install product

Go to https://products.technia.com and download the latest TVC and Helium installers. Use customer license file or generate a time bombed developers license.
Install TVC https://products.technia.com/app/docs/tvc-documentation-2024.1.0/tvc/install/index.html#installation
- Structure Browser
- Graphic Reporting
- Exclude schema - require ‘User Agent’ password (default is secret123)
Install Helium https://products.technia.com/app/docs/tvc-helium-documentation-2024.1.1/helium/admin/index.html#installation

Installation result and basic Setup

By now the web resources should be installed into your target 3dspace server folder. Value Component basic behaviour is controlled by global properties (e.g production mode for performance or development efficiency) . Let’s take a look at the result in 3dspace.

Exercise 2 - Installation result and Setup

‘3dspace/WEB-INF/web.xml’
- Search “tvc”, you should find an added servlet definition, mapping etc. <SCREENSHOT>
‘3dspace/WEB-INF/classes/helium.xml’
- Copy below code snippet with minimal setup (used for automatic routing based on object type)
‘3dspace/WEB-INF/classes/tvc.properties'
- Copy below code snippet (dev mode, debug logs, user agent)
Locate installed resources
- ‘3dspace/WEB-INF/lib/tvc*.jar
- ‘3dspace/tvc' (legacy classic component jsp’s)
- ‘3dspace/helium'
- ‘3dspace/webapps/helium'
- ‘3dspace/WEB-INF/tvc*.tld'
- ‘3dspace/WEB-INF/tvc' (configs go here in next step)
Start server (3dpsace tomee) and find tvc system init in logs <SCREENSHOT>

WEB-INF/classes/Helium.xml

<TODO/>

WEB-INF/classes/tvc.properties

tvc.TODO=debug
tvc.TODO=false
tvc.TODO=User Agent
tvc.TODO=secret123

Deploy a widget

Exercise 3 - Deploy a widget

Download and deploy Issues widget. <link to simple training zip app>

Predefined zip with a few files
- view and consider content, issue vs common domain xmls
- expand to WEB-INF/tvc
json widget spec
use add app in platform management
add app to dashboard from compass and test it

Basic Configuration

Exercise 4 - Modify widget configuration

Add an attribute column <docs link>

Using xsd schema and IDE validation support?

Add related data (assignee? or CR?) <docs link>

Add built in template fancy rendering example reference <docs link>

Modify data set to exclude closed issues? <docs link>

Add command using ootb service invoke <docs link>

Add priority pie chart <docs link>

<boilerPlate/>

Create Issue Configuration

Exercise 5 - Add issue create form

Add toolbar command <docs link>

Add form config <docs link>

<boilerPlate/>

HEX / Launch Pads

Exercise 6 - Download and reference a specific HEX / Launch Pad

Instructions <docs link>

You can use it as examples to see how things are done

<boilerPlate/>

Studio - Live widget configuration using UI (In-app designer)

Studio (In-app designer)

Most configurations could be made live directly from within the UI. This way server access and deploys (release) is no longer needed but view definitions are handled like data.

Covered in separate training.

Advanced / Dev

Advanced

There could be requirements outside what is possible by standard configuration. E.g. cells using custom calculation logic. The product supports a wide range of controlled extension plugins using well defined and upgrade safe interfaces.