...
| Table of Contents |
|---|
...
2024.5
| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Legal notes
Copyright 2022 by TECHNIA AB
All rights reserved.
PROPRIETARY RIGHTS NOTICE
This documentation is proprietary property of TECHNIA AB. In accordance with the terms and conditions of the Software License Agreement between the Customer and TECHNIA AB, the Customer is allowed to print as many copies as necessary of documentation copyrighted by TECHNIA relating to the software being used. This documentation shall be treated as confidential information and should be used only by employees or contractors with the Customer in accordance with the Agreement.
Preface
...
Value Components Cloud is the SaaS foundation for tailored 3DEXPERIENCE apps. As a configurable UI framework for making widgets, it is a cost-efficient solution compared to coding custom widgets from scratch. It also brings more and higher quality features than a coding project would normally do. Value Components Cloud is often used to raise productivity and user acceptance by streamlining workflows or filling gaps.
...
Value Components Cloud allows configuration of tailored 3DDASHBOARD widgets presenting data from standard OOTB services in any preferred way making users more efficient and
...
willing to accept using the platform. The framework contains many different building blocks, such as tables and forms, that could be configured individually into simple or together into more complex apps, all integrating well with OOTB functionality such as 6WSearch.
The widget framework and definition is hosted on TECHNIA.cloud
...
and/or on-prem platforms, and can be added to any 3DEXPERIENCE environment, including cloud tenants.
...
Custom widgets is a supported concept part of 3DEXPERIENCE platform and added by pasting a link into the administration dialog “Create Additional App“. The dialog allows adding widgets without any customization to the target environment just by adding the metadata of the whereabouts of the widget that is kept fully outside.
...
Value Component Cloud widgets calls all 3DEXPERIENCE data locally, between the 3DEXPERIENCE platform and the client browser. No 3DEXPERIENCE data, except user information for usage audit purposes (see agreement for details), is passed elsewhere or to the TECHNIA.cloud.
Supported
...
platforms
3DEXPERIENCE 2019x or higher
...
Subscription & Access
All widget configurations are controlled by an access token tied to a subscription.
Installation
TECHNIA.cloud
The widget framework and its configurations are hosted on TECHNIA.cloud. No additional install is required and ready to link to any 3DEXPERIENCE platform including DS Cloud.
The following resources are hosted on TECHNIA.cloud
Widget Framework (.html, .css, .js)
Widget Definition
Configuration (e.g. columns, datasets etc .json)
Code (e.g. custom rendering, data calculations etc .js)
Subscription detail
Usage data for audit (user name, app-id, timestamp)
| Info |
|---|
Refer to privacy policy for usage data details |
Subscription & access
Widget configuration access is controlled by a subscription and platform app-id. Subscriptions have an end date and a user count. As the subscription runs out or the user count is exceeded, the widget is no longer accessible.
| Info |
|---|
To control usage, the logged in user name is passed (and stored) each time a widget definition is loaded from TECNNIA.cloud. |
...
Fore more detail on the data stored see the privacy policy & data processing agreement. |
To avoid unauthorized use of your subscription keep your access token a secret and renew it with a cadence.
...
Widget Registration (TECHNIA.cloud)
All widget definitions are hosted on TECHNIA.cloud that is using a sub processor (e.g. AWS). For more detail on support etc see the agreement.
The following resources are hosted on TECHNIA.cloud
Hosted widgets are automatically registered to the APP-ID (generated by platform). Automatic registration applies to the first connect only. Adding the same configuration multiple times require registration. Connect with TECHNIA to register new a APP-ID.
Updates
The widget framework is evergreen and updates at least every 11 weeks. Updates could include improvements to existing functionality or new functionality enabled by configuration.
| Info |
|---|
All improvement, including quality fixes, is delivered with the latest update only, there will be no fix packs on previous locked versions. |
Controlled updates
| Tip |
|---|
Updates can be controlled by locking to a specific version, allowing validation before rolling new releases. |
<HOW TO LOCK>
On-prem
The widget framework and its configurations are hosted on the target on-prem system (3dspace/webapps).
Widget Framework (.html, .css, .js)
Widget
...
Updating Code resources
To add a custom js resource to use in configurations (e.g. custom dataHandlers) you can push a js file to the server using the following cURL.
| Code Block |
|---|
export SERVER=https://waas.technia.cloud
export COMPANY_ID=
export FILE=
export USER=
export PASSWORD=
export CONTENT_TYPE='Content-Type: multipart/form-data'
curl -XPOST ${SERVER}/api/v1/companies/${COMPANY_ID}/resources -H "${CONTENT_TYPE}" -F "file=@${FILE}" -u "${USER}:${PASSWORD}" -k |
Parameter detail
...
Parameter
...
Description
...
COMPANY_ID
...
A numeric identifier of your company. Where to get this?
...
FILE
...
The js file holding the new resource definition.
...
USER
...
An administration user with the proper access.
...
PASSWORD
...
The password of the administration user.
Installation
found under “Platform management” → “Members”.
Updates
Lock version? Evergreen?
Components
Technical concept
...
Definition
Configuration (e.g. columns, datasets etc .json)
Code (e.g. custom rendering, data calculations etc .js)
Widget definition - Administration
Customers sometimes control widget definitions themselves (depending on the agreement). Widget definition is currently managed over cURL using basic authentication (you can use git bash or similar terminal). To simplify administration and improve security further an admin UI with MFA is planned for later.
| Note |
|---|
Note that all modification to definitions is immediately reflected. Widget lifecycle management is not currently in place and it is recommended to use other specific widgets for dev and test purposes before updating the production definition. |
Listing configurations
The following cURL will list (id, name) of all configurations related to the admin user.
| Code Block |
|---|
export SERVER=https://waas.technia.cloud
export USER=
export PASSWORD=
curl ${SERVER}/api/v1/configs -u "${USER}:${PASSWORD}" -k |
Parameter Detail
...
Parameter
...
Description
...
USER
...
An administration user with the proper access.
...
PASSWORD
...
The password of the administration user.
Updating a Configuration
The following cURL template will update the widget definition and/or its name (used referring from 3DX).
| Code Block |
|---|
export SERVER=https://waas.technia.cloud
export CONFIG_ID=
export CONFIG_NAME=
export CONFIG_FILE=
export USER=
export PASSWORD=
export CONTENT_TYPE='Content-Type: multipart/form-data'
curl -XPUT ${SERVER}/api/v1/configs/${CONFIG_ID} -H "${CONTENT_TYPE}" -F "name=${CONFIG_NAME}" -F "config=@${CONFIG_FILE}" -u "${USER}:${PASSWORD}" -k |
Parameter detail
...
Parameter
...
Description
...
CONFIG_ID
...
A numeric identifier of the configuration. Can be found calling list configurations.
...
CONFIG_NAME
...
A string representation of the configuration. Could be changed, used when referring the widget from the “Create additional app” dialog.
...
CONFIG_FILE
...
The configuration file holding the new definition.
...
USER
...
An administration user with the proper access.
...
PASSWORD
...
The password of the administration user.
License file & usage data (user name, app-id, timestamp)
Login to https://products.technia.com and download and unpack value-components-widgets.war on 3dspace. Resources will be added to the following locations.
3dspace/webapps/value-components-widgets/The widget framework front end resources
3dspace/WEB-INF/lib/Configuration end-point
DS rest service extensions framework
License control
3dspace/WEB-INF/tvc/Included DS rest service extensions configurations (xml)
Adding a widget in 3DEXPERIENCE)
Adding widgets is standard functionality part of the 3DEXPERIENCE platform. To access the command you need to be logged in with an administration user with the access to “Platform Management”. Once in “Platform management” navigate to the “Members” tab and scroll down to “Additional Apps” and you will fins the “Create Additional App” command.
A dialog will appear and you should enter
Short Name - The app label as displayed to users in the compass
Type - Select “Widget”
Source code URL - Enter the widget framework URL & configuration.
| Info |
|---|
As you press Create the widget should be made available under the Compass within seconds. |
