General

  • How do I deploy a project to the Catalyst remote console?

    Once you create and test your application in your local machine using the CLI or any other tool, you can deploy the project to the Catalyst remote console in three ways:
     

    1. Using Catalyst CLI:
      You can deploy your project from the Catalyst CLI by executing the catalyst deploy command from the project's root directory. Refer to the Deploy Resources help page for more information.
    2. Uploading the files manually:
      • Client component: You can upload your project's client package manually to the Catalyst console and host the client component. Refer to the Web Client Hosting help page for a detailed explanation. 
      • Functions: You can create functions in your project directly from the Catalyst remote console, instead of creating them in your local machine. You can learn more about this from the Functions help page.
      • Android or iOS application: You can upload the source files of your Android or iOS application in Device Management in the Catalyst console. Refer to the Device Management help page for a detailed explanation.
    3. Downloading your project files from a GitHub repository:
      You can deploy the client and functions together or individually from your GitHub repository. You can learn more about this from the GitHub Integration help page
  • What does the "Deploy to Production" button in the Catalyst console do?


    You can use the Development environment to work with and test your Catalyst application during the development phase, and deploy it to the Production environment once it is ready to be made live. When you create a project, it will be created in the Development environment by default. 

    Once you deploy it to the Production environment, you will be able to switch between both environments in the Catalyst console and migrate your data between both environments. 

    Refer to the Environments help page for detailed help.

  • How do I delete an existing project in Zoho Catalyst?

    You can delete a Catalyst project in the following way:

    1. Open the project from the Catalyst console.
    2. Navigate to Settings and click General under Project Settings
    3. Click Delete Project in the General section.
    4. Click Yes, Proceed in the confirmation window. 

    Your project and its resources will be permanently deleted from the console. You will not be able to initialize this project from the CLI once it has been deleted.

  • How do I resolve the error "HTTP Error: 409 - The given function_name already exists"?

    If you encounter HTTP Error: 409, it means that a function with the same name already exists in the Catalyst console.

    You can either change the name in the catalyst-config.json file or delete the existing function in the remote console using the CLI or directly from the console.

Catalyst CLI

  • How do I work with Catalyst CLI?

    You can refer to the Installing Catalyst CLI help page for help with installing the Catalyst CLI.

    Once you have installed Catalyst CLI using the npm command, you can work with the CLI from your terminal. Catalyst commands begin with the keyword catalyst. You can refer to the CLI documentation for detailed help with all the CLI commands.

     

  • How will I know when there is a Catalyst CLI update?

    When a newer version of the Catalyst CLI is available, your terminal will display a message alerting you of it after you execute a CLI command successfully.


    To update your CLI, execute the following command:

    $ npm install -g zcatalyst-cli
     

    Notes:
    • In rare cases, your system's registry values might not reflect the latest version of Catalyst CLI. This might cause your system to retain the older version of the CLI. To avoid this, mention the version number while executing the command. For example, to update to the version 0.2.10, run $ npm install -g zcatalyst-cli @0.2.10
    • If you are unable to update Catalyst CLI, execute the command using sudo.

    Alternatively, you can visit the npm website to check whether you are using the latest version.

  • How do I report an issue in Catalyst CLI?

    If there are any issues or abnormal behaviors detected in the CLI, Catalyst will automatically create a catalyst-debug.log file in the directory the command executed. You can then contact the Catalyst team through our support email address: support@zohocatalyst.com

    Please provide a brief description of the issue and attach the catalyst-debug.log file in the email. The Catalyst team will contact you in less than 24 hours with a solution for the issue.

  • How do I resolve the "SyntaxError: Unexpected token" error while executing Catalyst CLI commands?

    Catalyst CLI only supports Node engines higher than 8.15. If you encounter this error, it could mean that you have a lower version of Node.js installed in your system. 

    You can update the Node.js version to resolve this error by downloading the Node.js installer from the Node.js website. You must then open the installer to install it on your system. To check if Node.js has been updated successfully, execute the following command in your terminal:

    $ node -v

  • How do I resolve the "Unable to get local issuer certificate" error when I execute a Catalyst command?

    You will encounter this error if strict TLS authorization has been enabled in your system. You can resolve this error by executing the following command in your terminal:

    $ set NODE_TLS_REJECT_UNAUTHORIZED=0

    You can now retry executing the Catalyst command. If the issue still isn't resolved, contact Catalyst support at support@zohocatalyst.com for further assistance.

  • How do I resolve the "JavaioInvoker has been compiled by a more recent version of the Java runtime" error?

    The CLI only compiles the Java classes at runtime. Therefore, if the version of the Java environment and the javac you are using are different, you will encounter this error.

    You can check the Java version by executing the following command in your terminal:

    $ java -version

    Similarly, you can check the javac version by executing the command in your terminal:

    $ javac -version

    If they are different, write the value of the Java path as "8" in the "PATH environment" variable and execute the command again. This will resolve the issue.

    If you have any further queries, you can contact Catalyst support at support@zohocatalyst.com.

Working with Catalyst Functions using an External Editor

  • How do I access Catalyst Java functions in my Eclipse editor?

    If you have created functions in the Catalyst remote console, you must download them to your local machine before you can access them in your editor. If you created functions on your local machine, you can skip to step 3.

    To access Catalyst Java functions in your Eclipse editor:
     

    1. Download your function's code from the remote console by executing the following Catalyst CLI command:

      $ catalyst pull

      You can refer to the Pull Resources help page for a detailed explanation.

      This will automatically create a functions directory in your project home containing your functions.
    2. Open your Eclipse editor. Navigate to File and then Open Projects From File System.

    3. Click Directory next to Input Source in the pop-up.

    4. Select the functions folder that was created using the CLI and click OK.
    5. Ensure that Add project to working sets is unchecked.
    6. Eclipse auto detects the Java functions in that folder. Select the functions you need from the list.

    7. Click Finish.

    Your Catalyst functions are now accessible in Eclipse.

  • How can I include an external JAR in a Java function and bundle it along with the Catalyst Java functions?

    1. Open your Java functions in Eclipse as described in the previous answer.
    2. Right click on your project from the package explorer and click Build Path and then Configure Build Path...

    3. Click the Libraries tab and select Add External JARs.

    4. Select the JAR to be included in the pop-up window and click Open.
    5. The selected JAR will be included in JARs and class folders on the build path. Click Apply and Close.

    6. Code your function with the JAR included and test the code by executing the following command from the CLI:

      catalyst serve

      You can learn about this command in detail from the Serve Resources help page.
    7. You can then directly deploy the function from the CLI without worrying about the additional JAR file. Execute the following CLI command to deploy the Java functions to the remote console along with the external JAR:

      catalyst deploy --only functions

      You can learn about this command in detail from the Deploy Resources help page.
    8. After the function has been deployed, you can verify whether the JAR has been added to your function group from the Catalyst console.

Catalyst SDK

  • How do I access Catalyst SDKs

    You can access Catalyst SDKs from two places in the Catalyst console:
     

    1. From the expanded menu in the project page:
      Open your project in the Catalyst console and click your profile picture. 

      The expanded menu contains the links to download various SDKs that you can use in your application.
    2. From the Developer Tools in Settings:
      The Developer Tools section in Settings also contains the links to access and download the SDKs that are available for your project. 

    You can refer to the Catalyst console help page for detailed help with accessing the SDKs and using the console.

  • How do I fix it if the 'getCurrentUser()' method in the User Management SDK returns null?

    If the client portal wasn't authenticated before triggering the Basic I/O or Advanced I/O function that contains the getCurrentUser() method, then the function will run using the admin authentication. This will cause the method to return a null response. 

    Therefore, you should ensure that you have authenticated the client portal before executing the getCurrentUser() method.

CI/CD

Pricing

  • What are 'Light' and 'Heavy' user plans? How do I choose a plan?

    'Light' and 'Heavy' user plans are automatically chosen by Catalyst based on your usage. You will always be charged based on the lowest plan. You can refer to the Pricing documentation for pricing information.

  • Is there a free plan in Catalyst?

    The Development environment is completely free of charge. You can use all Catalyst components and deploy your project in the Development sandbox for free of cost. Catalyst will begin charging your usage only after you deploy your project to the Production environment. You can refer to the Environments help page for more details about the Development and Production environments.

     

     

    Note: The Development environment has certain limitations.

     

     

  • How do I monitor my usage and billing in Catalyst?

    You can monitor your Catalyst usage and billing from the Billing section in settings. You can check the breakdown of your usage, view a comprehensive report, set budget limits for your usage, and more from the Billing section. You can refer to the Billing help page for more information.