Altium 365 Platform Starter App

Content Type: Sample
Categories: Connectors,Data

Overview

Altium 365 is the first open electronics hardware development platform for secure, seamless, and streamlined collaboration.

The Altium 365 Platform Starter App is designed to help developers quickly integrate with the Altium 365 Platform API. This preconfigured app comes with everything set up, allowing you to focus on extending functionality rather than handling complex configurations. It leverages the Altium 365 Platform Connector module directly from the marketplace and includes seamless OAuth 2.0 integration with Altium Identity. Additionally, the Starter App includes an extension to view your workspace projects right out of the box.

Documentation

Typical usage scenario

The Altium 365 Starter App enables developers to quickly integrate Mendix applications with the Altium 365 platform using a preconfigured setup. Customers can use this app to view their Altium 365 workspaces, manage the lifecycle status of components, and explore their workspace projects directly from Mendix.

This app is ideal for electronics hardware development teams who need a ready-to-use solution to streamline component management workflows. By eliminating the need for extensive configuration, the Starter App allows teams to focus on customization and extending functionality rather than setting up integration from scratch.

Features and limitations

  • Seamless integration with Altium 365 platform.

  • Preconfigured OIDC SSO setup for secure authorization with Altium Identity.

  • Accessing workspaces associated with a user’s Altium 365 account.

  • Edit and manage the lifecycle status of components directly within Mendix.

  • Module extension to view your workspace projects.

  • Scalable design, with potential for easily adding functionality in future releases.

  • Currently workspace viewing, project listing and lifecycle status editing are supported. However, this app is easily extensible and you can make use of any features available in our extensive Platform API.

Dependencies

  • Altium 365 License: An active Altium 365 account.

  • Mendix Studio Pro: The starter app is compatible with Mendix 10.15.0 and higher.

Installation and Configuration

  1. Download the Altium 365 Platform Starter App from the Mendix Marketplace.
  2. Configure a connection with Altium Identity and connect with your Altium 365 global workspace.
  3. Launch the app in Mendix Studio Pro to run it, or deploy a production-ready version onto the cloud.
  4. Log in with your Altium Identity credentials to access your workspace.
  5. Enjoy seamless interaction with your Altium 365 environment.

Frequently Asked Questions

Q: Is this starter app production ready?

A: Yes, using our secure OAuth 2.0 flow, this app can be used in production.

Q: Do I need an Altium 365 subscription to use this starter app?

A: Yes, an active Altium 365 account is required.

Q: Can I manage multiple Altium 365 workspaces at once?

A: Yes, you can view and manage all workspaces linked to your Altium 365 account through the connector.

Q: Is there support for other edit processes and workflows?

A: Currently, the only edit possible here is to change component lifecycle status. Further workflows may be added in future versions.

Q: How can I add new functionality to this starter app?

A: The app is designed for extensibility, and developers can add custom actions by extending the existing Mendix flows. We provide a guide on how to extend the module and have an example built in to show your workspace projects.

Q: How do you handle large libraries of components?

A: The starter app uses paging, but there may be a slight delay when loading a large number of components.

Q: Where can I find out what additional capabilities are possible?

A: You can make use of features available in our extensive Platform API.

Releases

Version: 1.0.0
Framework Version: 10.15.0
Release Notes: # Description The Altium 365 Starter App for Mendix is designed to help developers quickly integrate with the Altium 365 platform. This preconfigured app comes with everything set up, allowing you to focus on extending functionality rather than handling complex configurations. It leverages the Altium 365 Platform Connector module directly from the marketplace and includes seamless OAuth 2.0 integration with Altium Identity. Additionally, the Starter App includes an extension to view your workspace projects right out of the box. ## Release Notes - This app provides a preconfigured, hassle-free starting point for integrating Mendix applications with our [Altium 365 Platform Connector](https://marketplace.mendix.com/link/component/232835), with the following features: - View a list of your library components - Edit lifecycle status of components - Secure integration with OAuth 2.0 - Includes an additional module extension to view your workspace projects - [OIDC SSO](https://marketplace.mendix.com/link/component/120371) module pre-installed to quickly connect to Altium Identity for secure access to your Altium 365 workspace ## Dependencies - Altium 365 License: An active Altium 365 account. - Mendix Studio Pro: The module is compatible with Mendix 10.15.0 and higher. ## Installation and Configuration 1. Download the Altium 365 Platform Starter App from the Mendix Marketplace. 2. Configure a connection with Altium Identity and connect with your Altium 365 global workspace. - For more details, see: [Getting Started with Mendix](https://support.nexar.com/support/solutions/articles/101000538289). 3. Launch the app in Mendix Studio Pro to run it, or deploy a production-ready version onto the cloud. 4. Log in with your Altium Identity credentials to access your workspace and projects. 5. Enjoy seamless interaction with your Altium 365 environment.