CPI CopilotDocumentation

CPI COPILOT · VERSION 1.0

From connection
to a clearer view.

A practical guide to monitoring, understanding and troubleshooting your SAP Integration Suite integrations.

Updated 30 October 2026 · No sign-in needed to read this guide

Start with a test tenant. Use approved credentials and non-sensitive sample data. Choose a small set of known flows and compare the results with SAP before expanding your watch list.

What you can do

Product capabilities and common uses
ToolUse it for
MonitorWatch selected flows for failures, missed scheduled runs, stuck or retrying messages, and runtime changes. Optional queue inspection depends on SAP permissions.
Team WorkspacesShare a tenant connection, assign primary and backup responsibility, and give members a view of their assigned resources.
Steps & TraceNavigate an iFlow in execution order and inspect available captures from a specific SAP message run in your browser.
iFlow CompareReview differences between two flow states, including supported palette settings and script content.
Ask & ExplainAsk questions about your connected tenant or get an AI-assisted explanation of an integration. ZIP-based explanation does not require a tenant connection.
ReportsReview failures in scheduled daily reports or prepare a historical failure export for a selected period.
Build toolsDraft iFlows and supporting scripts. Review and test generated output before any deployment; complex custom mappings need particular care.

Monitoring reads SAP data. Separate build and management actions can change SAP artifacts or queue state when requested and authorized. Available features depend on account settings and your SAP permissions.

Connect your tenant

  1. Prepare access. Ask your SAP administrator for a dedicated, approved API credential for a Cloud Foundry Cloud Integration test tenant. For monitoring, use only the necessary read permissions. Successful sign-in to the SAP web interface does not establish API access.
  2. Create your account. Open CPI Copilot, register or sign in, and review the current Terms and Privacy Policy.
  3. Enter the connection. Open Settings → CPI Connection, or choose Connect a tenant in Monitor. Use values from the same approved SAP service key.
Connection fields
FieldWhat to enter
CPI Base URLThe Cloud Integration API base URL supplied by your administrator. Do not use the BTP cockpit address or a browser page ending in /shell.
Token URLThe complete OAuth token endpoint supplied with the credential. If it already ends in /oauth/token, do not add that suffix again.
Client IDThe approved API client's ID.
Client SecretThe matching secret. Enter it only in the secret field; never paste it into chat or a support email.
Web IDE URLOptional SAP design interface base URL, used for navigation. Keep it separate from the API base URL.

Leave the separate CPI Runtime fields empty for initial monitoring setup. They support other workflows such as Fix/Verify.

Use Test CPI Connection and Save Credentials. Confirm that packages and flows load, then compare a known recent message with SAP. A successful token request or package listing alone does not prove access to message logs and detailed diagnostics.

Choose two known test flows, review alert recipients and AI settings, then press Start. Listing flows, checking a connection and manually refreshing data can contact SAP before scheduled monitoring starts.

Monitoring & alerts

Your watch list selects which integrations routine monitoring follows. For each flow, enable the alerts you need. Missed-run detection requires an expected schedule, time zone and grace period; verify these against the actual SAP schedule.

  • Failure alerts: identify failed messages and available error context.
  • Missed runs: flag expected executions that were not observed within the configured schedule and grace period.
  • Stuck/retrying messages: highlight unfinished work that may need investigation.
  • Runtime changes: compare available execution timings to identify slowdowns.

Personal alert checks run approximately every five minutes; performance collection runs approximately every fifteen minutes. These are scheduled checks, not real-time delivery guarantees. SAP response times, available history, usage limits and mail delivery affect what you see and when.

When an “all clear” is eligible

A personal all-clear digest requires verified recent successful completions for every watched flow in the digest window, no reported failures or qualifying slowdowns, and no unfinished messages found by the current check. All-clear emails are limited to once per UTC day.

If watched flows have not run recently, an empty failure list does not trigger an all-clear. If SAP access or the API response cannot be verified, the monitoring email is withheld. Expired or unavailable tenants must be investigated before treating monitoring as healthy.

No email is not proof of health. A quiet inbox can mean no reportable issue, idle flows, disabled settings, a quota, unavailable SAP data or a delivery problem. Review connection status and compare with SAP's own monitor.

Stop or change monitoring

Use Stop to stop personal scheduled monitoring. Signing out or closing the browser does not stop it. Workspaces have their own monitoring and email controls. In-flight requests and emails already accepted by a provider may still finish.

Reports

Digests summarize the configured monitoring window. Daily failure reports use their own selected flows, delivery time and time zone; you can configure up to three daily schedules. Review a preview before enabling a schedule.

Historical reports prepare a failure report for a selected supported period. After preparation, review its status and download the available CSV or request delivery to permitted recipients. An expired export must be generated again.

Detailed reports may include SAP errors, custom headers and CSV attachments. Review their contents and recipients before sharing. Report preparation can take time; incomplete source reads or failed access checks can prevent delivery. If delivery is uncertain, check the inbox and status before requesting another send.

Temporary report exports expire; they are not a permanent archive. Save an approved copy if you need it, and follow your organization's retention rules.

Team Workspaces

  1. Create a Workspace and configure its dedicated shared tenant connection.
  2. Invite colleagues using the Workspace invitation flow. Owners and admins manage membership and assignments.
  3. Select the flows and optional queues to monitor, then assign primary and backup responsibility.
  4. Choose Urgent, Hourly summary or Dashboard only for supported resource alerts. Review the enabled email recipients.
  5. Enable Workspace monitoring and email delivery separately when ready.

A Workspace supports up to 30 selected flows and 10 queues. Members receive a view of their assigned resources; owners and admins have management access. Workspace monitoring does not borrow a member's personal SAP connection.

Workspace emails are sent separately to enabled recipients for their assignments. Detailed failure CSV delivery is opt-in and can include custom-header data. Workspace reports need verified SAP access and a recent successful monitoring check. Workspace monitoring does not include AI analysis.

Before deleting an account that owns a Workspace, transfer ownership. Shared Workspace data and credentials have a separate lifecycle from a member's personal connection.

Steps, Trace & Compare

Install CPI Copilot Tools from the Chrome Web Store, then open a supported iFlow in SAP Integration Suite. The extension is optional for web monitoring.

  • Steps: follow main flows, branches and local processes in execution order. Select a step to locate it on the SAP canvas.
  • Trace: select the exact message run and inspect the bodies, headers, properties and errors SAP captured. Available detail depends on SAP logging and retention; missing captures cannot be reconstructed by the tool.
  • Compare: compare supported flow snapshots to review palette, configuration and script changes before making an edit.

Trace payload inspection runs in your SAP browser tab without uploading those payloads to CPI Copilot or an AI service. Deterministic Steps and Compare also operate locally. Optional AI Explain is a separate backend processing path; review its data handling before invoking it.

Trace observations are investigation aids. An empty field or changed value alone does not establish the root cause of a failed message. Confirm findings against SAP and the receiver's requirements.

AI tools

Use Ask, Explain, script assistance and generation to accelerate investigation and drafting. Outputs can be incomplete or incorrect; validate them against SAP, your integration requirements and a test tenant.

Some interactive AI actions support a provider key configured in Settings. A personal AI key does not mean data bypasses CPI Copilot. Do not assume personal provider settings apply to background email analysis.

If external AI processing is not approved, turn off AI root-cause analysis in emails before enabling personal monitoring and avoid AI actions. This email option is not a global switch for every AI feature, and it does not remove sensitive information from errors or emails.

Generation drafts structure and supporting scripts. Review the selected tenant, artifact and proposed changes before invoking any upload, replacement, deployment or queue action.

Security & data handling

  • Credentials: saved SAP credentials are encrypted. The backend decrypts them to perform authorized operations; this is not end-to-end encryption or customer-exclusive key custody.
  • SAP access: monitoring reads operational information and metadata. Other requested tools can download designs or perform writes if SAP permissions allow. The watch list is not a substitute for SAP authorization.
  • Information leaving SAP: errors, identifiers, custom headers, designs, prompts and diagnostic content can contain business or personal data. Selected information can reach email recipients or AI providers when those features are used.
  • Email: turning off AI does not redact alert contents. Use approved recipients and sanitized test examples. Delivered emails cannot be recalled by stopping monitoring.
  • Retention: stopping monitoring or revoking SAP credentials does not erase stored application records, provider records or delivered emails. Export expiry is not a general data-deletion guarantee.

Use a dedicated credential with only approved permissions. Do not grant write access merely to clear a monitoring connection error. For revocation or rotation, follow your SAP administrator's procedure; already-issued tokens may remain usable until they expire. Empty secret fields can preserve saved values rather than delete them.

For account/data deletion or an organizational security review, contact support@cpicopilot.com. Review the Privacy Policy and Terms of Service before connecting your data. This guide does not promise a certification, an availability SLA or compatibility with every SAP landscape.

Troubleshooting

Common issues and next checks
IssueWhat to check
404 / not foundConfirm the API base URL with your administrator. A cockpit/design page address, an incorrect host/path, or an expired/unavailable trial tenant can produce a not-found response. A 404 alone does not prove the cause; check tenant availability in SAP.
401 / authentication failureCheck the token URL and matching client ID/secret. Confirm whether credentials were revoked, expired or rotated.
403 / permission failureAsk your administrator to validate the read permissions needed for the failed operation. Do not grant broad administrator or write access as a shortcut.
Flows load, but messages do notPackage access and message-log access are separate. Confirm permissions, the selected flow, time window, actual executions and SAP's available history.
No “all clear”Check whether every watched flow completed a run in the digest window, whether any unfinished work was found, and whether an all-clear was already sent today in UTC.
No expected alert/reportCheck monitoring state, selected flows, schedules/time zone, recipient settings, connection errors, usage allowances, report status and spam folders. Test emails verify mail delivery, not SAP monitoring access.
Trace is emptySelect the correct message run. Confirm that SAP captured the detail and that it remains available under the tenant's logging and retention settings.
AI reaches a limitReview account allowances. Where supported, configure an approved personal provider key. Do not assume this changes background email analysis.

Pricing & access

You can currently get started free, without a credit card, subject to account and service usage allowances. AI usage, email delivery and resource selections have limits; free access does not mean unlimited usage.

There is no published enterprise price list or enterprise SLA. Contact support to discuss your evaluation and licensing needs. Any future paid subscription will show its price before you subscribe. See the current pricing overview and Terms.

Support & demos

For a walkthrough, setup assistance or a security discussion, email support@cpicopilot.com. For a demo, suggest your time zone, a few suitable times and the features you want to evaluate.

For an issue, include the action taken, approximate time and time zone, HTTP status if known, and a redacted screenshot or error. Do not send service keys, client secrets, passwords, access tokens or business payloads. Support can help coordinate with your SAP administrator without receiving your credentials.

Start with a test tenant