Chapter goals & duration
In this chapter you will learn the basics on how to install and configure Helium widgets. You will also learn where to find documentation, examples, installers & license.
Expected duration 2-4h.
1. Prerequisites
3DEXPERIENCE dev env (tomee 3dspace exploded web app)
Basic xml understanding
(OPTIONAL) IDE - VSCode, Eclipse or similar
2. Installation
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
Include 'Collaboration', ‘Structure Browser’ & 'Graphic Reporting'
Exclude Schema (requires ‘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
3. 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 have 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, filter, mapping etc. https://products.technia.com/app/docs/tvc-documentation-2024.1.0/tvc/install/index.html#using_tvc_with_proxy_server_or_load_balancer
‘3dspace/WEB-INF/classes/helium.xml’ https://products.technia.com/app/docs/tvc-helium-documentation-2024.1.1/helium/admin/index.html#helium
Copy below minimal setup code snippet (used for object routing etc)
‘3dspace/WEB-INF/classes/tvc.properties'
Copy below properties, remove conflicts from ‘web.xml’
Start server (3dpsace tomee)
Verify that TVC system initialize correctly in logs
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)
Launch log watcher (require admin user) https://<baseurl>/3dspace/tvc/core/tvcLogWatcher.jsp
Clear TVC cache (require admin user) https://<baseurl>/3dspace/tvc-action/clearCache
(Optional) Misc
Set log levels runtime
Monitor status & set runtime param
showActionMappings
MQL client
..
WEB-INF/classes/Helium.xml
<?xml version="1.0" encoding="UTF-8"?> <Application xmlns="http://technia.com/helium/Application"> </Application>
WEB-INF/classes/tvc.properties
tvc.core.logLevel=DEBUG tvc.core.productionMode=false tvc.core.user=User Agent tvc.core.password=secret123 tvc.3ddashboard.showEndUserConfigObjects=false
4. Deploy a widget
<update with correct url and json?
<SCREENSHOT compass app and resulting widget>
Widget definition is done in discrete separate XML files under '3dspace/WEB-INF/tvc'. The separation enable reuse, e.g. a description column could be defined once and referred by hundreds of widgets, ensuring the same hight quality cross the full application.
Definition structure overview.
https://products.technia.com/app/docs/tvc-helium-documentation-2024.1.1/helium/admin/index.html#page
Exercise 3 - Deploy a widget
Download issues widget. <issues-widget.zip>
Expand zip to ‘3dspace/WEB-INF/tvc’
View, consider and understand overall file structure.
Reflect on domains ‘3dspace/WEB-INF/tvc/traning/common’ vs ‘3dspace/WEB-INF/tvc/traning/issue’, how could it be used?
json widget spec < 3dspace PATH>
Go to 3ddashboard → platform management → add app (use below sample url)
Find app in compass, add to a dashboard and test it
json sample, widget url
<TODO/>
5. Basic Configuration
<SCREENSHOT RESULT><DOCS LINK>
Exercise 4 - Modify widget configuration
It is recommended to TEST all below steps incrementally (refresh widget in dev mode)
Open an IDE and use .xsd schema support to understand configuration options for a column
Add Priority column (copy an existing column, use issue domain, reflect why) <docs link>
Add related data column (Assignee and Change Request) <docs link>
Add built in template for fancy Priority rendering <docs link>
Modify data set to exclude closed issues (or elaborate, maybe past year only..) <data set docs link>
Add command using calling ootb service (create connect CR?) <docs link>
Charts
Priority & State pie chart <docs link>
Originated line
Owner bar
Drag drop to OOTB widget (by adding it to the standard common conf all future use will benefit)
Enable built in table settings (data group, export, sort, filter….)
Related Assignee and CR inc group header
<boilerPlate/>
Style cell using built-in handlebar template
<boilerPlate/>
Modify Data set to exclude closed issues
<boilerPlate/>
Toolbar command to add CR using service invoke
<boilerPlate/>
Add priority pie
<boilerPlate/>
6. Create Issue form configuration
<SCREENSHOT create form and highlighted new row>
Exercise 5 - Add issue create form
Add toolbar command <docs link>
Add form config <docs link>
TEST
Toolbar sample
<boilerPlate/>
Create form sample
<boilerPlate/>
7. Issue page routing
TODO issue-page.zip
Exercise route config in helium.xml
8. Launch Pads
<SCREENSHOT MY DOCUMENTS PAD>
<LINKS>
Exercise 6 - Download, expand zip and reference a specific Launch Pad
Instructions <docs link>
Useful as runnable documentation or real project templates
Link all issues view to navigate route into Launch Pad issue view?
<boilerPlate/> or json
9. Debug and troubleshot
Log watcher (e.g. spelling mistake column ref)
XSD validation
Browser dev tools
10. Standalone app?
NOT IN TRAINING BUT sneak peak
Exercise.. Try open
<BASE URL>/3dspace/goto/d/helium/launchpad/issue/MyIssuesSummarized
<SCREENSHOT>
11. 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.
Studio is not included in this training.
<SCREENSHOT studio>
12. 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.
Development of advanced use cases is not covered in this training.
<DATA HANDLER example?>
<SCREENSHOT complex column>
<DataHandler reference/>