App deployment
Deploying applications is how you give value to end users by releasing app updates. Apps can be deployed from the development environment to the test environment by the app developers.
App deployment is necessary for transferring your fully developed app from development to the target environment i.e., the test or production environment.
Deployment process
The app deployment process goes through three stages: previewing the flows that are going to be deployed, initiating the deployment, successful deployment if there are no errors.
Deployment preview
To preview the flows that will be included in a deployment, click the arrow icon in the top-right corner of the app builder and click Deploy. This action will display a preview window with the list of core changes that will be pushed to the target environment in this build. The actual deployment process will begin only when you click Deploy in this pop-up. Verify the flows and customize the version number if required.
Note: You can click cancel any time at this stage and go back to the app builder but you cannot stop the deployment once you click the Deploy button here and start the deployment process.
What are core changes?
The term core changes refers to the following flows: Board, Process, Dataform, Integrations, Analytics, and Page. Your app may contain other flows and components along with these but in this preview window only the aforementioned flows will be displayed.
The following are some of the exceptions that will not be listed in the deployment preview:
- Connections in integrations.
- Custom components.
- Decision table.
- External data objects.
- Roles.
- Navigation menus.
- Any changes to the app name, description, display icon.
Notes:
1. The flows listed marked as core ones are not mandatory to be present in your app for a successful deployment.
2. Once the deployment process is initiated, all the flows and components in your app will be deployed, irrespective of whether they are part of the core changes list or not.
Initiating deployment to the target environment
- In the preview window, click Deploy.
- The deployment process will begin. All the flows included in this build will be validated and deployed one by one.
3. Upon successful deployment, you will be notified via the success pop-up, and through in-app and email notifications.
4. After the first deployment, all the integrations in your newly deployed app will be turned off by default. Click the link present in the success pop-up to go to the integrations page and manage them. You may have to reauthenticate the connectors to turn on the integrations.
Note: In the subsequent deployments, integrations will be turned off if any of the following applies to them:
If the integration is newly added in this deployment.
If it is a previously archived integration that was unarchived for this deployment.
If the integration has updated triggers.
Disabled integrations can be turned on manually post-deployment.
Troubleshooting deployment failure
App deployment can fail if the flows included in the app fail to pass the validation check that happens during the deployment process.
Possible error scenarios include:
- If an integration that is still active in the previous build of this app is archived for the current deployment, then it will throw an error. To fix this, you must turn off the particular integration in the target environment and initiate the deployment again.
- API failure during deployment. You will be provided with the reason and/or a request ID. You can contact our support team with the request ID for further assistance on the errors.
Please note that if you get any kind of error during deployment, it will be considered a failed deployment and recorded in the deployment history as such. To deploy the app, you must resolve the errors and initiate the deployment again.
Note: You can refer to the error details in the deployment history page as well. However, if you are unable to see the errors in deployment history, it could be because that was an older deployment attempt made prior to this update.
Deployment on hold
App deployment could be put on hold if there is a data type mismatch in one or more flows in your app. This is not an error scenario as you can resolve the data type mismatch in the deployment window and continue with the deployment.
Once you resolve the errors and click on continue, the deployment process will begin again.
Deployment dependencies
Application deployment will fail if you have employed application-to-application lookup in your app.
The Dependencies from other apps popup appears when you have created form lookups from other applications that are not yet deployed.
This popup displays the list of linked apps and the forms and fields in your application that uses the data. To fix this dependency, the applications listed here must be deployed first. Only then will you be able to deploy your application.
Note:
Deployment dependencies occur when you link two undeployed apps and look up data from one app to another.
You will not encounter deployment dependencies in the following cases:
โข If you link an undeployed app to yours without looking up data from it.
โข If you link a deployed app and create data lookups from that app to yours.