To make your UI Component available, you'll need to deploy and publish it. To be able to deploy a UI Component, we'll first need to add some configuration.

Registration

To be able to deploy a UI Component, you will first need to register it in the platform. Go to Studio > UI Components and click Add new UI Component. Enter a name that is recognisable for end-users, then click Add.

Deploy and publish

UI Component deployment is a two stage process, deploying and publishing. Deploying uploads your code to the IXON Cloud in draft allowing you to check and test it. Publishing enables the UI Component for all users.

📘

Notes

• The user account that is used for publishing needs to have a role with the Develop apps permission.
• If you use an iframe adapter, you have to build the UI Component before you can deploy it.

First, make sure you are logged in. This can be done via the login command as shown below, this will ask you to fill in your IXON Cloud credentials.

npx cdk login

Now that you are logged in, you can deploy your UI Component to the cloud, to do this, run the deployment command. If this is the first time you deploy the component, it will ask for the Company ID and UI Component ID (this is Public ID of the UI Component).

npx cdk deploy hello-world

A preview link will be displayed in the output. You can do a last check with this link to see if your UI Component works as intended. To make your component available to everyone in the company, publish it.

npx cdk publish hello-world

It will ask you to select the version you want to publish. Once done, all users in the company can use your (updated) component.

Deploying updates

After deploying and publishing a first version, you can keep uploading new versions. Your users will remain on the published version, until you publish a new version.

📘

Note

• The version number needs to be increased in the manifest file every time a new version is deployed.