Legal Notes

Copyright 2022 by TECHNIA AB

All rights reserved.

Preface

Widget as a Service (WaaS) is a configurable widget framework for the 3DEXPERIENCE platform and is a cost efficient solution to raise productivity and user acceptance.

WaaS allows configuration of tailored 3DDASHBOARD widgets presenting data from standard OOTB services in any preferred way making users more efficient and happy 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. Access controlled by subscription and token it can be added to any 3DEXPERIENCE environment, including cloud tenants. The widget is 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.

Widget as a Service consume 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. Subscriptions have an end date and a user count. As the subscription runs out the widget is no longer accessible.

Hosting

All widget definitions are hosted on TECHNIA.cloud (currently on AWS). For more detail please refer to the agreement.

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)

Setup (Adding a widget in 3DEXPERIENCE)

Updates

Lock version? Evergreen?

Widget Definition & Administration

Customers or customer representatives (consultants) sometimes control widget definitions themselves (depending on the agreement). Widget definition is currently managed over https://curl.se/ using basic authentication (you can use git bash or similar terminal).

List Configurations

The following cURL will list the id and name of all configurations related to the admin user.

export SERVER=https://waas.technia.cloud
export USER=
export PASSWORD=
curl ${SERVER}/api/v1/configs -u "${USER}:${PASSWORD}" -k 

Parameter Detail

Create a Configuration

The following cURL template will create a new widget definition.

export SERVER=https://waas.technia.cloud
export CONFIG_NAME=
export CONFIG_FILE=
export USER=
export PASSWORD=
export CONTENT_TYPE='Content-Type: multipart/form-data'
curl -XPOST ${SERVER}/api/v1/configs -H "${CONTENT_TYPE}" -F "name=${CONFIG_NAME}" -F "config=@${CONFIG_FILE}" -u "${USER}:${PASSWORD}" -k 

Parameter detail

Update a Configuration

The following cURL template will update the widget definition and/or its name (used referring from 3DX).

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

Create / Update a Code resource

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.

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

Components

Technical concept

Configuration