Versions Compared

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 widget and make some basic modifications to it. You will also learn where to find documentation, examples, installers & license.

...

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.zip>

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

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

  • json widget spec < 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 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

Panel
panelIconId1f446
panelIcon:point_up_2:
panelIconText👆
bgColor#F4F5F7

Exercise 5 - Add issue create form

Add toolbar command <docs link>

Add form config <docs link>

TEST <SCREENSHOT>

Toolbar sample

Code Block
<boilerPlate/>

Create form sample

Code Block
<boilerPlate/>

HEX / Launch Pads

Panel
panelIconId1f446
panelIcon:point_up_2:
panelIconText👆
bgColor#F4F5F7

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

Instructions <docs link>

You can use it as examples to see how things are doneUseful as runnable documentation or real project templates

Code Block
<boilerPlate/>

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

Info

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.

<SCREENSHOT>

Advanced / Dev

Info

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.

Covered in separate training.

<DATA HANDLER example?>