Index of every page on this site: llms.txt
All skills
github avatar

/sap-cloud-integration

@f10fdb8 official
by githubgithub/awesome-copilot41k stars
5,399
Run it yourself

SAP Cloud Integration (CPI, part of SAP Integration Suite) runtime-specific guidance for building and troubleshooting iFlows. Use when writing or reviewing CPI Groovy scripts, choosing headers vs. exchange properties, designing exception subprocesses, JMS retry, idempotency or data store patterns, or diagnosing adapter errors (SFTP, HTTP/OAuth, SOAP, IDoc, OData, AS2, Cloud Connector) from Message Processing Log (MPL) text. Not for SAP PI/PO, ABAP development, or generic Java/Groovy outside CPI.

  • 7 files
  • 42.5 KB
  • Updated last week
  • GitHub
Use this Skill: https://skilld.dev/gh/github/awesome-copilot/sap-cloud-integration

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencesgroovy-scripting.md

≈1.8k tokens on demand. Your agent reads this file only when SKILL.md points to it.

Groovy scripting in SAP Cloud Integration

Script contract

import com.sap.gateway.ip.core.customdev.util.Message

def Message processData(Message message) {
    // work on the message
    return message
}
  • The Script step calls processData by default. Another function name can be set in the step's Script Function field.
  • messageLogFactory is available as a binding. Get the log with messageLogFactory.getMessageLog(message) and null-check it.
  • Shared code belongs in a Script Collection that iFlows reference. Do not copy the same script into many iFlows.
  • Scripts run concurrently for different messages. Keep them stateless: no static mutable fields and no caching between calls.

Body access

Call Behavior Use when
message.getBody(java.io.Reader) Streams the body Large or unknown-size payloads; line or record processing
message.getBody(java.io.InputStream) Streams raw bytes Binary, or passing the stream on unchanged
message.getBodySize() Returns the body size in bytes without converting the body. Returns -1 when the body type cannot report its size: treat that as unknown and too large Before any full read: decide whether getBody(String) is safe
message.getBody(String) Loads the whole payload into memory as a String; SAP warns that String or byte[] conversion of large bodies can cause out-of-memory failures on the worker Small payloads only (configuration, tokens, short JSON), after a size check
message.setBody(x) Accepts String, byte[], or InputStream Prefer a stream for large output

For large XML, split with a General/Iterating Splitter with Streaming enabled before the script, or parse with StAX. XmlSlurper and XmlParser both build the whole document in memory.

Reading a Reader line by line (eachLine) bounds memory only for line-delimited formats with bounded lines (CSV, flat files). Minified JSON or XML is often a single line, so eachLine then loads the whole payload. Use a streaming parser or a streaming splitter for those.

Headers and properties

def orderId  = message.getHeader('X-Order-Id', String)   // typed header read
def headers  = message.getHeaders()                      // Map, includes Camel* and SAP_* names
def retry    = message.getProperty('retryCount')         // exchange property
message.setHeader('SAP_ApplicationID', orderId)          // searchable in Monitor
message.setProperty('targetSystem', 'S4P')               // stays inside this iFlow run

See headers-properties-expressions.md for scope rules.

Message Processing Log (MPL)

def log = messageLogFactory.getMessageLog(message)
if (log != null) {
    log.setStringProperty('OrderId', orderId)              // shown in the MPL properties
    log.addCustomHeaderProperty('OrderId', orderId)        // searchable via Custom Header Properties
    if (message.getProperty('logPayload') == 'true') {     // property set from an externalized parameter
        long maxBytes = (message.getProperty('logPayloadMaxBytes') ?: '102400') as long  // externalized cap, default 100 KB
        long size = message.getBodySize()                  // no body conversion; -1 = size unknown
        if (size >= 0 && size <= maxBytes) {
            log.addAttachmentAsString('Request', message.getBody(String), 'text/plain')
        } else {
            String reason = size < 0 ? 'Body size unknown' : "Body is ${size} bytes; limit is ${maxBytes}"
            log.setStringProperty('PayloadNotLogged', reason)
        }
    }
}
  • MPL attachments are stored in the tenant database and are kept with the log. A tenant can write at most 1 GB of MPL attachments per 24 hours; after that, attachments are no longer stored, for any iFlow, until usage drops below the limit. Gate attachments behind a flag that a Content Modifier sets from an externalized parameter (for example {{LOG_PAYLOAD}}), and cap their size with getBodySize() (for example {{LOG_PAYLOAD_MAX_BYTES}}). Do not write attachments in short-interval retry loops.
  • Never attach or log credentials, tokens, or personal data.
  • addCustomHeaderProperty is the right tool for values support teams search on (order ID, file name, partner). Use setStringProperty for diagnostic detail.

Security material and value mapping

import com.sap.it.api.ITApiFactory
import com.sap.it.api.securestore.SecureStoreService
import com.sap.it.api.securestore.UserCredential
import com.sap.it.api.mapping.ValueMappingApi

def secureStore = ITApiFactory.getService(SecureStoreService.class, null)
UserCredential cred = secureStore.getUserCredential('S4_TECH_USER')   // alias deployed in Security Material
String user = cred.getUsername()
String pwd  = new String(cred.getPassword())                           // char[]; do not log it

def vm = ITApiFactory.getService(ValueMappingApi.class, null)
def target = vm.getMappedValue('S4', 'Plant', '1000', 'WMS', 'Site')   // returns null when no entry exists
  • Handle a null value-mapping result explicitly: fail with a clear message or apply a documented default.
  • Credentials come only from deployed Security Material aliases, never from externalized parameters or headers.

Errors

  • Throwing an exception sends the message to the Exception Subprocess, if one is modeled. The text becomes ${exception.message}.
  • Use a clear, actionable message, for example IllegalStateException("Header X-Order-Id is missing; check the sender Allowed Header(s) setting").
  • Do not swallow exceptions and return the message unchanged. The MPL then shows Completed for a failed message.

Avoid

  • System.out.println. Output does not appear in the MPL; use messageLog.
  • Thread.sleep or polling loops. Use JMS retry or a Timer start instead.
  • Outbound HTTP calls from a script. Use a Request-Reply step with a receiver adapter so security material, Cloud Connector, and monitoring apply.
  • Building XML or JSON with string concatenation. Use groovy.xml.MarkupBuilder / StreamingMarkupBuilder or groovy.json.JsonOutput / JsonBuilder.

Template: validate a header, set monitoring keys, record body size

import com.sap.gateway.ip.core.customdev.util.Message

def Message processData(Message message) {
    String orderId = message.getHeader('X-Order-Id', String)?.trim()
    if (!orderId) {
        throw new IllegalArgumentException("Required header 'X-Order-Id' is missing or blank.")
    }
    message.setHeader('SAP_ApplicationID', orderId)

    long size = message.getBodySize()                     // no body conversion; -1 = size unknown
    message.setProperty('bodySize', size)

    def log = messageLogFactory.getMessageLog(message)
    if (log != null) {
        log.addCustomHeaderProperty('OrderId', orderId)
        log.setStringProperty('BodySizeBytes', size.toString())
    }
    return message
}

Downstream steps can route on ${property.bodySize}, for example sending large or unknown-size (-1) payloads to a streaming splitter.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at f10fdb8. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated last week

README badge

README badge for github/awesome-copilot/sap-cloud-integration