There are a lot of default components available to show machine data on a Portal card or on pages. However, it is also possible to use self-built components. This can be done by developing custom components by using the Component SDK (Software Development Kit). This gives the opportunity to use components that are exactly tailored to the kind of information that a machine can provide.
NotePlease contact your Sales representative first before initiating the development of custom components.
The following information can be found in this article:
- Introduction to the Component SDK
- Where to find what information
- Process steps to request and upload a custom component
Introduction to the Component SDK
The Component SDK has been created to aid in the development of custom components. It is also used by IXON internally in the development of IXON components. The Component SDK makes developing custom components easy and secure as it has the following benefits:
- It has a built-in versioning system.
- Components can be tested before they are deployed. This can also be done locally.
- The custom components themselves are hosted in IXON Cloud.
- Working locally makes the development of custom components quicker.
The Component SDK consists of the following elements:
- Project workspace boilerplate.
- Built-in support for frameworks (component wrapping).
- Component starter templates.
- Simulator app (ComponentContext with mock-data).
- Deployment and publishing tools for automation.
Where to find what information
Support website (this article)
This article is the starting point and describes the process of creating a custom component. It gives information on how to request and upload a custom component. Therefore, it is advisable to carefully read through all the steps.
The Component SDK and instructions to build a custom component can be found on GitHub: https://github.com/ixoncloud/component-workspace
In the SDK there are 5 example components that can be selected when generating a new custom component:
- Plain JS demo (YouTube player)
- Plain JS simple
- Svelte simple
- Vue demo (sticky note)
- Vue simple
Detailed development documentation
More detailed development documentation can be found on our developer website: https://developer.ixon.cloud/docs/custom-components
Process steps to request and upload a custom component
By using the Component SDK, a component template is built and tested locally first. Next, the component can be uploaded to the company account to test the draft version. After the final tests, the component template can be published to make it available for all users in the company account where the component template is published. This complete process consists of these steps:
- Read the README.md on GitHub.
- Download the sources from GitHub.
- Develop and test a component template locally until an early version is ready.
- Create a new page component template in IXON Cloud.
Currently, this is not fully automated yet. For creating a new template, an email can be sent to email@example.com with a request to create a new custom component template and by providing these details:
- The company name
- The Company ID
- The name of the component template
- If the component will be used on a main page (Main page: yes/no).
- Deploy the new version to the company account. When deploying, the component template is uploaded to IXON Cloud and a preview link is available, which can be shared. E.g. with a client or colleagues.
For uploading the component template both the Company ID and the page-component-template ID are required. The Company ID can be found at Admin > Company info > Company ID. The page-component-template ID can be found in the confirmation e-mail.
- If the preview is fine, the component template can be published. At this moment, it becomes available in IXON Cloud.
- Optionally, it is also possible to share the component template with another company account.
Currently, this is not fully automated yet. For sharing a template, send an email to firstname.lastname@example.org with a request to share a custom component template and by providing these details:
- The source company name
- The source Company ID
- The target company name
- The target Company ID
- The page-component-template ID
- The version number needs to be increased every time a new version is deployed.
- The user account that is used for publishing needs to have the role of Platform administrator.
- If a third party is hired to develop the custom component, it might be undesirable that they are given the role of Platform administrator in a company account that is used for production. A better solution is to create a separate company account, where the third party has full access, and afterward share the custom component template with the company account that is used for production.