integration-procedure-cacheable-patterns
Use when designing Integration Procedures (IPs) with platform cache to cut latency and callout load. Covers cache key design, TTL selection, per-user vs org-wide partitions, invalidation on data changes, and safe fallback on cache miss/stale. Does NOT cover general IP authoring (see omnistudio-error-handling-patterns) or LWC client-side caching.
Best use case
integration-procedure-cacheable-patterns is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Use when designing Integration Procedures (IPs) with platform cache to cut latency and callout load. Covers cache key design, TTL selection, per-user vs org-wide partitions, invalidation on data changes, and safe fallback on cache miss/stale. Does NOT cover general IP authoring (see omnistudio-error-handling-patterns) or LWC client-side caching.
Teams using integration-procedure-cacheable-patterns should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/integration-procedure-cacheable-patterns/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How integration-procedure-cacheable-patterns Compares
| Feature / Agent | integration-procedure-cacheable-patterns | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Use when designing Integration Procedures (IPs) with platform cache to cut latency and callout load. Covers cache key design, TTL selection, per-user vs org-wide partitions, invalidation on data changes, and safe fallback on cache miss/stale. Does NOT cover general IP authoring (see omnistudio-error-handling-patterns) or LWC client-side caching.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Integration Procedure Cacheable Patterns ## Purpose Integration Procedures are the workhorse for orchestrating DataRaptors and external callouts in OmniStudio. Many IPs return mostly-static data — product catalogs, entitlement matrices, rate tables — that is re-fetched on every UI load. Platform Cache inside an IP cuts latency and callout volume by orders of magnitude, but only if the cache key, TTL, partition, and invalidation are designed together. Teams either skip caching (slow) or cache too aggressively (stale data, cross-user leakage). This skill codifies the decisions. ## Recommended Workflow 1. **Measure.** Log IP latency and call volume. Cacheability is a decision, not a reflex — some IPs shouldn't be cached. 2. **Design cache key.** Include every input that changes the result AND nothing that doesn't. Stable ordering matters. 3. **Pick partition.** Org-wide for shared data (catalogs, metadata), Session for per-user data (entitlements when scoped to the user). 4. **Choose TTL.** Align TTL to source-data SLA. Default 5-15 minutes for quick wins; longer needs explicit invalidation. 5. **Design invalidation.** Record-triggered flow or Apex trigger on the source object purges cache keys when data changes. 6. **Plan fallback.** Cache unavailable (partition full, platform error) must not break the IP. Fall through to live fetch. 7. **Monitor cache hit ratio.** < 40% suggests wrong key or wrong TTL. ## Cache Key Design - Include: inputs that change the result, the API version, and the feature flag set that governs behavior. - Exclude: request ids, timestamps, user-identity if the result is org-wide. - Keep keys short but unambiguous; platform cache has key-length limits. Example key: `ip:PricingMatrix:v3:sku=ABC123:region=NA:tier=GOLD` ## Partition Selection | Partition | Scope | Use For | |---|---|---| | Org-wide | All users | Catalogs, reference data | | Session | Per user | Entitlements, personalized results | Do NOT put user-specific data in the org-wide partition. Data leaks. ## TTL Guidance - Reference data that rarely changes: 30–60 min with explicit invalidation. - User entitlements: 5–10 min. - Pricing: 5–15 min. - Anything regulated / audit-bound: keep short and verify invalidation works. ## Invalidation Patterns - **Event-driven:** record-triggered flow publishes a Platform Event; invocable Apex clears the matching cache key. - **Versioned keys:** bump a version field in the key prefix when the schema changes; old keys age out naturally. - **Namespace purge:** clear an entire prefix during deploys for safety. ## Fallback - `getPartition()` may return null if the partition is missing or full. - Code the IP to treat cache as an accelerator, not a dependency. - Never let a cache miss produce an error surfaced to the user. ## Anti-Patterns (see references/llm-anti-patterns.md) - Cache results of callouts that return per-user PII into org-wide. - Hash the entire input blob as a key (breaks invalidation). - TTL 24h with no invalidation plan. - Assume cache always succeeds. ## Official Sources Used - OmniStudio Integration Procedures — https://help.salesforce.com/s/articleView?id=sf.os_design_integration_procedures.htm - Platform Cache — https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_cache_namespace_overview.htm - OmniStudio Caching — https://help.salesforce.com/s/articleView?id=sf.os_use_platform_cache_to_improve_integration_procedure_performance.htm - Salesforce Well-Architected Performant — https://architect.salesforce.com/docs/architect/well-architected/performant/performant
Related Skills
scim-provisioning-integration
Use when designing or reviewing SCIM-based user lifecycle provisioning into Salesforce from Okta, Azure AD / Entra, or another IdP — create/update/deactivate, group-to-permission-set mapping, attribute mapping, and deprovisioning semantics. Triggers: 'scim provisioning', 'okta scim salesforce', 'entra salesforce provisioning', 'user deactivation automation', 'group to permission set mapping'. NOT for SSO/authentication setup (see single-sign-on skills).
mfa-enforcement-patterns
Design MFA enforcement: auto-enablement, Salesforce Authenticator rollout, exceptions, service accounts, API-only users, SSO interop, and audit. Trigger keywords: MFA, multi-factor, two-factor, Salesforce Authenticator, MFA exception, MFA SSO, api-only MFA. Does NOT cover: end-user password policies, device-trust posture, or non-Salesforce IdP configuration.
encrypted-field-query-patterns
Design SOQL, filters, reporting, and indexes against Shield Platform Encryption fields. Trigger keywords: Shield Platform Encryption, encrypted field query, probabilistic vs deterministic encryption, encrypted SOQL filter, encrypted field index. Does NOT cover: Classic Encryption (deprecated), field-level security policy, or tenant secret key rotation.
apex-managed-sharing-patterns
Grant row-level access programmatically via __Share records when declarative sharing rules cannot express the policy. NOT for OWD, role hierarchy, or criteria-based sharing rule design.
omnistudio-testing-patterns
Use when testing or validating OmniStudio components — OmniScript preview, Integration Procedure step debugging, DataRaptor field-mapping validation, and end-to-end UTAM-based automation. NOT for Apex unit testing or standard Flow debugging.
omnistudio-lwc-integration
Use when embedding OmniScripts in Lightning Web Components, registering custom LWC elements inside OmniScript screens, or calling OmniScript/Integration Procedures from LWC. Triggers: embed omniscript in LWC, custom LWC element in OmniScript, call OmniScript from Lightning page, omnistudio-omni-script tag, seed data JSON, OmniScript launch from LWC. NOT for standalone LWC development, standard Flow embedding, or OmniScript-to-OmniScript embedding.
omnistudio-error-handling-patterns
Use when designing fault behavior across Integration Procedures, DataRaptors, OmniScripts, and FlexCards — error routing, user-facing messaging, retry semantics, and idempotency. Triggers: 'omnistudio error', 'integration procedure fault', 'dataraptor error handling', 'omniscript retry', 'flexcard action failure'. NOT for general Apex exception design or Flow fault paths.
omnistudio-ci-cd-patterns
Use when designing or implementing CI/CD pipelines for OmniStudio components — DataPack export/import, versioning, environment promotion, and automated deployment. NOT for standard Salesforce metadata CI/CD or Apex-only pipelines.
omniscript-design-patterns
Use when designing or reviewing OmniScripts for guided experiences, step structure, branching, save/resume, and the boundary between OmniScript, Integration Procedures, DataRaptors, and custom LWCs. Triggers: 'omniscript design', 'too many steps in omniscript', 'save and resume omniscript', 'branching in omniscript', 'when should this be an integration procedure'. NOT for deep Integration Procedure or DataRaptor design when the guided interaction layer is not the main concern.
integration-procedures
Use when building, reviewing, or debugging OmniStudio Integration Procedures. Triggers: 'integration procedure', 'IP', 'HTTP action', 'DataRaptor', 'rollbackOnError', 'failureResponse'. NOT for Apex-only integrations unless the main design choice is whether OmniStudio is still appropriate.
flexcard-design-patterns
Use when designing, building, or reviewing OmniStudio FlexCards — including data source selection, card states, actions, conditional visibility, flyout configuration, and child card iteration. Triggers: 'FlexCard', 'card template', 'flyout', 'card action', 'card state', 'data source', 'child card', 'conditional visibility'. NOT for OmniScript design, standalone LWC development, or Apex controller architecture outside the FlexCard context.
dataraptor-patterns
Use when designing or reviewing OmniStudio DataRaptors, especially Extract versus Turbo Extract versus Transform versus Load, field mapping strategy, performance tradeoffs, and when to move work into Integration Procedures or Apex. Triggers: 'DataRaptor Extract', 'Turbo Extract', 'DataRaptor Load', 'DataRaptor Transform', 'OmniStudio data mapping'. NOT for overall OmniScript journey design or Integration Procedure sequencing when the main question is not the DataRaptor shape itself.