UiPath Documentation
apps
latest
false
Coded Apps user guide
  • Getting started
    • About Coded Apps
    • Licensing
  • Working with Coded Apps
    • Building and deploying Coded Apps
    • Sample Coded Apps
    • FAQ
  • Coded Apps in Studio Web
  • Coded Action Apps
important :
For documentation on app projects in Studio Web, refer to the App Projects chapter in the Studio Web documentation: https://docs.uipath.com/studio-web/automation-cloud/latest/user-guide/apps-in-studio-web.

Building and deploying coded apps

Build and deploy a coded app in UiPath: what you need before you start, how the app is built in an IDE, and how to publish and deploy it to an Orchestrator folder.

A coded app starts as a web application that a developer writes in their own IDE, and ends as an app your users open from a UiPath URL. This page describes that journey and the deployment steps that take place in UiPath.

The process includes four stages:

  1. Defining the app logic in an IDE.
  2. Establishing a secure connection to UiPath.
  3. Deploying the app to Orchestrator.
  4. Accessing the app within the UiPath ecosystem.

Before you begin​

Make sure the following are in place:

  • A local development environment with Node.js 20.x or newer, and npm, used to build the app and install the UiPath tooling. Download the installer from nodejs.org, which includes npm. To check what is already installed, run node -v and npm -v.
  • The UiPath CLI, with the codedapp tool installed. For installation instructions, see the UiPath CLI guide.
  • An External App ID from an external application registered in your organization. The app uses it to sign users in and to call UiPath services on their behalf. A coded app runs in the browser and cannot store an app secret, so register it as a Non-confidential application with user scopes. To register one, see Adding an external application in the Automation Cloud admin guide.
  • Permission to publish packages and deploy apps in the Orchestrator folder you are targeting.

Build the app​

The developer builds the app the same way they would build any web application, in the framework of their choice, such as React, Vue, or Angular. UiPath adds two things to that workflow:

  • A connection to your organization. A config file at the root of the project identifies your organization, tenant, and External App ID. The UiPath TypeScript SDK reads this configuration, so the app can call UiPath services such as Orchestrator, assets, storage buckets, and processes.
  • A local development setup. A UiPath plugin for the project's build tool supplies that same configuration while the app runs on the developer's machine, so the app can be tested against a real tenant before it is deployed.

Both are a one-time setup per project. For the full developer setup, including the configuration file, the build tool plugin, and the adjustments the app needs before it is packaged, see Getting started with Coded Apps in the SDK documentation.

Deploy the app​

Deployment happens in two parts: the developer packages and publishes the app, then you deploy that package to an Orchestrator folder.

Package and publish the app​

A coded app is published to Orchestrator as a .nupkg package, the same package format used for automations.

  1. Build the app:

    npm run build
npm run build

  2. Package the build output:

    uip codedapp pack dist -n <appName> --version 1.0.0
uip codedapp pack dist -n <appName> --version 1.0.0

  3. Sign in to your UiPath organization:

    uip login
uip login

  4. Publish the package to a tenant feed or a personal workspace feed:

    uip codedapp publish
uip codedapp publish

  5. Deploy the app:

    uip codedapp deploy
uip codedapp deploy

For the full argument list of each command, see uip codedapp in the UiPath CLI guide.

Deploy the app from Orchestrator​

If the package has already been published, or if you prefer not to use the command line, deploy the app from Orchestrator instead.

  1. In Orchestrator, go to Tenant > Packages.
  2. Select Upload and upload the .nupkg file created by uip codedapp pack. For the detailed procedure, see Managing packages.
  3. Go to the folder where you want to deploy the app, and go to Automations > Apps.
  4. Select Deploy app, then select your app and its version. For the detailed procedure, see Managing apps.

Deploy the app from Studio Web​

If the app is built as a coded app project inside a Studio Web solution, it is packaged and deployed together with that solution rather than on its own. The version of the coded app stays in lockstep with the workflows, agents, and resources it depends on.

  1. Build the app locally, then push it into the Studio Web project:

    uip codedapp push --project-id <project-id>
uip codedapp push --project-id <project-id>

  2. In Studio Web, open the solution and select Deploy.

  3. Set the package version, choose whether to pack to your personal workspace or to a shared one, name the deployment, select folder and select Deploy.

For the full set of options in the deployment panel, see Publishing and deploying solutions in the Studio Web user guide.

Your app is now available at https://<orgName>.uipath.host/<appName>.

  • Before you begin​
  • Build the app​
  • Deploy the app​
  • Package and publish the app​
  • Deploy the app from Orchestrator​
  • Deploy the app from Studio Web​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated