Versions Compared

Old Version 12

changes.mady.by.user Anders Axelsson

Saved on

compared with

New Version 13

changes.mady.by.user Anders Axelsson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconId1f3af
panelIcon:dart:
panelIconText🎯
bgColor#DEEBFF

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 where to find documentation & , examples, download binaries installers & license.

Prerequisites

  • Access to a 3DEXPERIENCE dev env (tomee 3dspace exploded web app)

  • Basic xml understanding

  • Optional IDE (vscode, eclipse or similar)

Installation

The installers adds web resources to 3dspace (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.

Info

Gradle

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

Gradle is a separate training.

Panel
panelIconId1f4bf
panelIcon:cd:
panelIconText💿
bgColor#F4F5F7

Exercise 1 - Install product

...

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 have a look at the result in 3dspace.

Panel
panelIconId1f446
panelIcon:point_up_2:
panelIconText👆
bgColor#F4F5F7

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, more info in docs)

  • ‘3dspace/WEB-INF/classes/tvc.properties'

    • Copy below code snippet (dev mode, debug logs, user agent, more properties found in docs)

  • Locate all 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>

  • (Optional) Launch log watcher (require admin user) <URL>

WEB-INF/classes/Helium.xml sample

Code Block
<TODO/>

WEB-INF/classes/tvc.properties sample

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

...

Panel
panelIconId1f446
panelIcon:point_up_2:
panelIconText👆
bgColor#F4F5F7

Exercise 3 - Deploy a widget

  • Download and deploy Issues widget. <issue-widget.

<link to simple training zip app>

  • Predefined zip with a few fileszip>

    • view, consider and consider understand all file content, issue vs common domain xmlsexpand

  • Expand zip to ‘3dspace/WEB-INF/

    tvc

    tvc’

  • json widget spec

  • use add app in platform management

  • add app to dashboard from compass < 3dspace PATH>

  • Go to 3ddashboard → platform management → add app

    • Add widget <SCREENSHOT><URL>

  • Find app in compass, add to a dashboard and test it <SCREENSHOT>

json sample

Code Block
<TODO/>

Basic Configuration

Panel
panelIconId1f446
panelIcon:point_up_2:
panelIconText👆
bgColor#F4F5F7

Exercise 4 - Modify widget configuration

  • Add

an

  • attribute Priority column (consider domain common or issues) <docs link>

  • Using xsd schema and IDE validation support? <xsd link>

  • 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>

  • TEST incrementally or at the end <SCREENSHOT>

  • Optional misconfigure xml and use tvc log watcher to find details

Attribute

Code Block
<boilerPlate/>

XSD validation with IDE

Code Block
<boilerPlate/>

Related Assignee and CR inc group header

Code Block
<boilerPlate/>

Style cell using built-in handlebar template

Code Block
<boilerPlate/>

Modify Data set to exclude closed issues

Code Block
<boilerPlate/>

Toolbar command to add CR using service invoke

Code Block
<boilerPlate/>

Add priority pie

Code Block
<boilerPlate/>

Create Issue Configuration

...