Undeploy, Unlock, Data Store: SAP CPI Admin Tasks in One Place

Three small administrative tasks come up every week in SAP Cloud Integration (SAP CPI): stop an iFlow, take over an iFlow a colleague left locked, and remove a stuck Data Store entry. Each one lives on a different monitor screen, and each one can do damage if it hits the wrong iFlow.

This article explains what each task really does, where SAP keeps it, and how to do all three from the iFlow you are looking at, with a confirmation that names what will change.

Undeploy an iFlow

Undeploying removes the iFlow from the runtime: it stops processing messages, its endpoints stop answering, and its pollers stop, until it is deployed again. The design-time iFlow in its package does not change.

In SAP's monitor it is under Manage Integration Content: select the deployed iFlow and choose Undeploy. Check the name twice; similar names are common.

Remove a design-time lock

When someone opens an iFlow in edit mode, the designer locks it for everyone else. A lock left by a closed browser or a colleague on holiday blocks the team. Removing it lets you edit, but changes the holder has not saved in the designer are lost, so ask them first when you can.

In SAP's monitor, design-time locks are under Manage Locks.

Delete a Data Store entry

Data Stores hold messages an iFlow writes for later: for a retry, for a later step, for another iFlow. An entry that is never picked up, a test entry or a duplicate can block a flow or confuse it. Deleting an entry cannot be undone.

In SAP's monitor, Data Stores and Variables are under Manage Stores.

All three from the iFlow you are looking at

In Kitegra, open the iFlow, click the "Kitegra" button and choose "iFlow info". The panel shows:

• Deployment: Version, State, Deployed by, Deployed on, and whether Trace is on.
• Endpoints, each with a copy button.
• Edit lock: "Locked for editing by … since …", or "Nobody holds an edit lock on this iFlow."
• Data Store entries of this iFlow, each to show or download, and its Variables.

Its actions ask first and name what they change. Undeploy asks you to type the iFlow's name. Unlock names the holder and warns that their unsaved changes will be lost. Delete names the store and the entry and says it cannot be undone. On a tenant marked PROD in the extension, the dialogs also say "This tenant is marked PROD." Afterwards the panel shows SAP's answer: "Done." or "SAP refused: …".

What runs behind the buttons

The three actions use SAP's documented Cloud Integration API, the same calls you can script yourself:

# Undeploy an iFlow from Cloud Integration
DELETE https://<tenant>/api/v1/IntegrationRuntimeArtifacts('<iFlow ID>')

# Remove a design-time lock
DELETE https://<tenant>/api/v1/IntegrationDesigntimeLocks(ResourceId='<resource ID>')

# Delete one Data Store entry
DELETE https://<tenant>/api/v1/DataStoreEntries(Id='<entry ID>',DataStoreName='<store>',IntegrationFlow='<iFlow ID>',Type='<type>')

# Each call needs a token from GET with the header "X-CSRF-Token: Fetch",
# sent back as X-CSRF-Token, and a user with the matching role.

Undeploy acts on Cloud Integration only; the artifacts of an Edge Integration Cell are not undeployed from here. Your SAP user still needs the roles for each action: the extension does nothing your user could not do in SAP's monitor.

Switch them off when your policy requires it

If your company does not allow changes from a browser extension, turn off "Allow actions that change the tenant" on the options page. Undeploy, Unlock, Delete and Trace then disappear, and the extension refuses them. The panel still shows everything it reads.

These are part of the iFlow Inspector of the Kitegra, next to the design checks of the review checklist. Trace, the fourth action, has its own rules.

The Helper, Message Monitor, iFlow Inspector and iFlow Docs each count the iFlows you use them on: 5 per module without an account, 50 on the Free plan, 100 on Starter and 300 on Pro; Business has no limit. The Toolbox and the workspace extras are free. Compare the plans.

Try it in your next iFlow

Read what Kitegra adds around the SAP Integration Suite designer, or see it next to its modules.

Frequently asked questions