The Custom Widgets menu allows users with Admin role to manage the process related to the development and use of custom widgets in their project.

This process includes repository management, user management, trusted projects and more.
Details about these aspects are explained in the dedicated sections below.

images/confluence/download/attachments/5156266621/landing_page_with_order_repository-version-2-modificationdate-1736944054000-api-v2.png

Prerequisites

You are assigned to the Admin role or higher.

The project you own is a paid plan project.

The project members who will be granted access the GitHub repository need to be "logged in" as a Bosch Employee.
Currently we only support users using this identity provider.

Proceed as follows:

Navigate to Admin > Custom Widgets on the main menu.
→ Тhe Custom Widgets landing page opens.
Fulfill the relevant tasks as described below.

Setting up a repository for custom widgets

Custom widgets for projects can be developed, reviewed, maintained, and shared through dedicated managed project repositories at GitHub, within the organization called Insights Customers.
As an Admin of a project based on a paid plan, you can order such a managed repository in a few simple steps.

For details about the GitHub organization, you can refer to the Admin guide.

Proceed as follows:

On the Custom Widgets landing page, click Order Repository.
Follow the wizard:
1. On the first wizard step, read through the prerequisites and restrictions and when ready, click the Next button.
  In particular, these are related to:
  - a "Bosch Employee" account,
  - one repository per project,
  - compliance with the security guidelines for coding.
2. On the second wizard step, read through the information and type I confirm in the input field.
  Then click Next.
3. On the third wizard step, you can go Back or Cancel the order, or confirm with Subscribe.
  → Once you click Subscribe, the repository will be set up automatically in the background.
  
  → When the repository is successfully created, its name is displayed on the Custom Widgets landing page, in the Project repository area, along with a link for access, which can be copied.

Accessing the repository

Access by the Admin

Access to the project repository for the project Admins is not mandatory, but possible. If you would like access:

Add yourself as a user, following the steps described below in Adding users to the repository.
→ The number of already added users is shown in the top left corner of the Project repository area.
When you have been added successfully, click the link of the repository name.
→ The repository opens in a new tab.
Log in with your credentials.
If you need more details related to the login requirements, refer to the Developer Guide, Accessing the GitHub repository.

Access by invited users

When the Admin of a project invites you to the project's GitHub repository, the system will automatically request and approve for you the required "oneIDM" role for access.

You will receive a series of emails:

An email from Bosch IoT Insights informing you about the invitation
Emails from "oneIDM" regarding the status of the role request, e.g. requested and completed
An email from Bosch automation, informing you that you can join the respective GitHub repository

At this point, to join successfully, you need a GitHub account associated with the email address from the invite, as well as Multi-Factor Authentication.

If you need more details related to the login requirements, refer to the Developer Guide, Accessing the GitHub repository.

Adding users to the repository

As an Admin of a project, you can add its relevant members to the project's GitHub repository.

For that, the project account of these users must be associated with the "Bosch Employee" login.

Follow these steps:

Click the settings icon in the top right of your Project repository.

→ The user management view opens.
→ You can see the number of users already added the repository, as well as their names and status, e.g. Active, Access Requested, etc.
To add more users, select them from the drop-down list or use the search functionality.
You can only add human users and not technical users.
Click Save.
→ Your changes are saved.
→ The process of requesting and approving access for the user is automatically started in the background.

In case of problems with the access and need for troubleshooting, refer to Adding users - detailed process description.

→ The invited user will receive a series of emails to complete the process.
→ In the meantime, his or her status will be Access Requested.
→ When the whole process is completed and the user is successfully logged in to the repository, his or her status will change to Active.

To learn more about the possible statuses, refer to Access statuses explained.

Removing users from the repository

If you would like to withdraw the access of a certain user from the GitHub repository:

Click the delete icon on the row of the respective user (see screenshot above)
Click Save.
→ The user can no longer access the GitHub repository.

For further information, refer to Removing users - detailed process description.

Reusing custom widgets from another project

Proceed as follows:

On the Custom Widgets landing page, in the Trusted project names field, add the technical name of one or several projects that you trust with their custom-developed widgets.
Contact the Admins of these projects and ask them to whitelist your project in the respective custom widget(s) manifest file(s), as described in Configuring the manifest file.
Click Save to confirm your choice.
→ When all is ready, these custom widgets will be available for you when you are adding widgets to a dashboard.
→ See also Adding widgets and Widget types > Custom widgets.

Deprovisioning a repository

If you no longer need the GitHub repository for your project, you can trigger the process of its deprovisioning.

In that case, Bosch IoT Insights will:

remove the repository from GitHub, and
withdraw the corresponding access rights from the respective users, as long as these rights are not used by them for access to another project.
In particular a request will be triggered for the revoking of the oneIDM roles for each such user.

Proceed as follows:

To deprovision a repository:

Click the settings icon of the repository.
Click the red Unsubscribe button in the top right area.