How to Undeploy a Process

Document created by pete_mccoy1.3055586893899446E12 Employee on Jul 20, 2012Last modified by thanh_n88 on Jul 16, 2018
Version 3Show Document
  • View in full screen mode
The following instructions assume you have Environments are enabled. If Environments are not enabled, you'll be moving the Atom from the "Attached Atoms" window to the "Unattached Atoms" window instead

What we call "undeploy" can also be used interchangeably with "detach".

Legacy Deployment

If you have the legacy deployment feature, you can refer to Detaching an environment from one component.

  1. Go to the "Deploy" page
  2. Find your process and click on the process name
  3. The "Deployments" tab should populate, click on the "Attachments" tab
  4. In the "Attached Environments" list, select the environment(s) that you want to detach from the component
  5. Click ">>" to detach or undeploy the process
  6. The component is no longer deployed and it is disabled so that it cannot be executed manually or automated with a schedule

 

Package Deployment

If you have the newer deployment packages feature, you can refer to Undeploying a deployed package.

  1. Go to the "Deploy" and select the Deployments page
  2. Find the package that you want to undeploy, you might need to clear the time filter or use a different filter
  3. Click on the "Actions" menu (the blue gear icon) next to the package
  4. Select Undeploy and confirm you want to undeploy
  5. The component is no longer deployed and it is disabled so that it cannot be executed manually or automated with a schedule

 

Undeploy via the Atomsphere API

You can also programmatically undeploy via the Atomsphere API. If successful, you will get a simple "true" response back. 

 

Accounts with Legacy Deployment and without Environments

Refer to the Component Atom Attachment object and Process Atom Attachment object documentation for implementation or use the provided Atomsphere API connector. You'll be using the delete operation. 

 

Accounts with Legacy Deployment and Environments

Refer to the Component Environment Attachment object and Process Environment Attachment object documentation for implementation or use the provided Atomsphere API connector. You'll be using the delete operation. 

 

Accounts with Package Deployment

Refer to the Deployed Package object documentation or use the provided Atomsphere API connector. You'll be using the delete operation. The deployment ID can be found via a query of the Deployed Package object and then used in the delete operation. The deployment ID is not the same as the package ID you can find from the package details window. 

 

Here's a simple sample process to automatically undeploy packages via the Atomsphere API for an environment:

  1. Query for the necessary information, in this case the deployment ID. I used the environment ID as a filter parameter to get all of the deployments back. If you want to be more specific, add more filters
  2. Set the "Undeployment" connector's id parameter as the corresponding profile element's deployment ID coming out from the query
5 people found this helpful

Attachments

    Outcomes