Common Pitfalls

Error messages during deployment

๐Ÿ“˜

Api-Company: Invalid value

Make sure that the right Company ID is used for "company" in config.json. Also check that the right page-component-template ID is used for "template" in config.json.

๐Ÿ“˜

Authorization: Invalid value

Use npx cdk login to login again.

๐Ÿ“˜

Body must include a main file

Make sure that the entry "main" in manifest.json contains the prefix that is defined as "prefix" in config.jsonand the name of the component matches. For example:

"main": "pct-demo-component.min.js",
"prefix": "pct",

"components": {
  "demo-component":  {

๐Ÿ“˜

Body must include a manifest.json file

Correct the wrong dependencies by correcting the versions in package.json and running npm install. In the below example all versions should be changed to 1.2.6 before running npm install.

  "devDependencies": {
    "@ixon-cdk/core": "^1.2.6",
    "@ixon-cdk/runner": "^1.2.6",
    "@ixon-cdk/simulator": "^1.2.6",
    "@ixon-cdk/static-builder": "^1.1.0",
    "@ixon-cdk/svelte-builder": "^1.2.1",
    "@ixon-cdk/templates": "^1.2.6",
    "@ixon-cdk/vue-builder": "^1.2.1"
  },

๐Ÿ“˜

Not allowed

Log in with a user account that is a Platform administrator. Use an account that doesn't have access to multiple company accounts with a mix of 2FA turned on or off or where the account isn't a Platform administrator.

๐Ÿ“˜

version: Already exists

Increment "version" in manifest.json.

Deploying a UI Component doesn't ask for a Company ID and a page-component-template ID

The Company ID and a page-component-template ID are possibly already configured in config.json.
Change "company" to your Company ID and change "template" to your page-component-template ID.
For new deployments, also check that "version" in manifest.json is "1".

Intermittently a UI Component is not displayed in the simulator

Install the right dependencies by using the following steps to import a downloaded UI Component into your project:

  1. Create your project, install the dependencies and generate a new UI Component:
npx degit ixoncloud/component-workspace demo-project
cd ./demo-project
npm install
npx cdk generate downloaded-component
  1. Delete all files in the folder ./demo-project/components/downloaded-component.
  2. Copy the content from downloaded-component to the folder ./demo-project/components/downloaded-component.
  3. Login and run the simulator:
npx cdk login
npx cdk simulate downloaded-component