本文へ移動
cccskills
無料GitHub で公開

omnistudio-admin-configuration

Use when configuring OmniStudio at the org level: enabling Standard Runtime, selecting the Runtime Namespace, assigning Permission Set Licenses, toggling feature settings, and granting Experience Cloud community access. Trigger keywords: OmniStudio Settings, Standard OmniStudio Runtime, managed package runtime, runtime namespace, OmniStudio Permission Set, OmniStudio PSL. NOT for moving an org off the vlocity namespace — use omnistudio/vlocity-to-native-omnistudio-migration. NOT for deciding whether to adopt OmniStudio — use architect/omnistudio-vs-standard-decision.

インストール方法を見る

含まれるファイル(7)

  • SKILL.md15.7 KB
  • references/examples.md4.2 KB
  • references/gotchas.md7.8 KB
  • references/llm-anti-patterns.md10.1 KB
  • references/well-architected.md5.6 KB
  • scripts/check_omnistudio_admin_configuration.py9.6 KB
  • templates/omnistudio-admin-configuration-template.md3.6 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

OmniStudio Admin Configuration

Use this skill when an org requires initial OmniStudio configuration or when runtime, namespace, or permission problems are blocking component activation. It covers two independent configuration axes — runtime mode selection and permission set assignment — that must both be correct for OmniStudio to function. A gap in either axis causes activation failures, missing UI, or components that appear active but silently error at runtime.

This skill is explicitly scoped to org-level setup. It does not cover OmniScript step design, DataRaptor logic, Integration Procedure orchestration, or namespace migration from Vlocity to native.


Before Starting

Gather this context before working on anything in this domain:

  • What is the current setting for Standard OmniStudio Runtime in Setup > OmniStudio Settings? Is it enabled or disabled?
  • What value is set in the Runtime Namespace field? Is it blank, omnistudio, vlocity_ins, vlocity_cmt, or vlocity_ps?
  • Which Salesforce edition and OmniStudio license are in use — Industries (included), standalone OmniStudio SKU, or Vlocity managed package?
  • Who needs access — internal builders, internal consumers only, or Experience Cloud / community users as well?
  • Has any component already been opened in the Standard OmniStudio designer? (If yes, that component cannot be reverted to managed package runtime.)
  • Is Enhanced Runtime Performance on or off? It is a security change, not a tuning knob — see below before recommending either state.

Core Concepts

Runtime Mode Selection

OmniStudio supports two runtime modes that are mutually exclusive at the component level. Managed Package Runtime uses the installed Vlocity or OmniStudio managed package LWC components. Standard OmniStudio Runtime (also called native runtime) uses the Salesforce-platform-native LWC components shipped with the org.

Enabling Standard OmniStudio Runtime is a one-way toggle per component. Once a component is opened and saved in the Standard designer, it cannot revert to the managed package runtime path. Orgs in a mixed state — some components on native, some on managed — can cause inconsistent behavior and should be treated as transitional, not permanent.

To enable Standard Runtime: Setup > OmniStudio Settings > enable Standard OmniStudio Runtime. The same page contains a toggle to Disable Managed Package Runtime (OmniStudio Settings: disableManagedPackageRuntime), which prevents further use of the managed package components and forces all activity through the native runtime.

Runtime Namespace Configuration

The Runtime Namespace field in OmniStudio Settings controls which managed package namespace is active for the org. Valid values are:

  • omnistudio — for orgs that have the native OmniStudio package or are fully on Standard Runtime
  • vlocity_ins — Insurance and Health Cloud
  • vlocity_cmt — Communications, Media, and Energy Cloud
  • vlocity_ps — Public Sector Solutions

Leaving this field blank or entering an incorrect namespace causes component activation failures that surface as generic errors. This field must match the actual installed namespace. If Standard Runtime is fully enabled and no managed package is present, set the namespace to omnistudio.

Enhanced Runtime Performance and User Mode

Enhanced Runtime Performance is a toggle on the OmniStudio Settings page (Setup > Quick Find > Omnistudio Settings). It is a security change with a performance name. Salesforce Help describes it as ensuring "that Omnistudio communicates with the Salesforce Platform with in-platform capabilities instead of through Apex calls" — removing the Apex hop — and states that the setting makes all components execute in user mode, which "respects the access levels of the person performing an operation." Components that previously reached data through the managed package's Apex layer now stop at the running user's object and field permissions, so a user without the requisite object or field permissions cannot complete key actions.

Two consequences an org-level setup must plan for:

  • A prerequisite object grant. Users need access to the Omni Interaction Access Configuration object; Salesforce documents this as a before-you-begin item, with a dedicated permission set. Beyond that, every persona running a component needs CRUD and FLS on everything its Data Mappers and Integration Procedures touch.
  • It gates the Apex entry point. Invoking Integration Procedures from Apex through the Connect API (documented as ConnectAPI.OmniDesignerConnect.integrationProcedureExecute) requires Enhanced Runtime Performance to be enabled; when it is disabled, Integration Procedure calls from Apex do not route through the Connect API. Copy that identifier from the help topic rather than recalling it — it is not in the Apex Reference Guide.

Salesforce is explicit about rollout: do not enable the setting directly in production — test it in a production-like sandbox first. This is an org setting and is independent of the Apex apiVersion user-mode default, which is pinned per class in .cls-meta.xml — see Apex security idiom by API version for that separate rule.

Permission Set Licenses and Assignment

As of Winter '24, OmniStudio consolidates user access into a primary Permission Set License (PSL): OmniStudioPSL. Two core permission sets are derived from this PSL:

  • OmniStudio Admin — for builders and administrators who author OmniScripts, DataRaptors, and Integration Procedures. Grants access to the OmniStudio designer and all configuration tabs.
  • OmniStudio User — for consumers who interact with published OmniScripts and FlexCards. Does not grant authoring access.

Assigning a permission set without the underlying PSL will fail silently or with a generic error. PSL assignment must precede permission set assignment in bulk provisioning workflows.

Experience Cloud Community User Access

Experience Cloud (community) users require additional configuration beyond the standard OmniStudio User permission set. A custom permission set must be created that enables the community consumer custom permission, then assigned to the community profile or permission set group. Without this, authenticated and guest community members will receive access-denied errors even if all standard permission sets are assigned.


Common Patterns

Greenfield Native Runtime Setup

When to use: A new org or sandbox with no prior Vlocity install needs OmniStudio configured from scratch.

How it works:

  1. Go to Setup > OmniStudio Settings.
  2. Enable Standard OmniStudio Runtime.
  3. Set Runtime Namespace to omnistudio.
  4. Assign OmniStudioPSL Permission Set License to all builder and user accounts.
  5. Assign the OmniStudio Admin permission set to builders.
  6. Assign the OmniStudio User permission set to consumers.
  7. Verify by opening the OmniStudio app and confirming the designer and list views load.

Why not the alternative: Skipping the Runtime Namespace field leaves it blank, which causes silent activation failures on first component save.

Community / Experience Cloud User Access

When to use: Community members — authenticated portal users or guest users — need to run OmniScripts embedded in Experience Cloud pages.

How it works:

  1. Complete the standard greenfield or managed-package setup first.
  2. Create a new Permission Set with the OmniStudio Community User custom permission enabled.
  3. Assign this permission set to the community profile or to the Experience Cloud permission set group.
  4. In Experience Cloud Builder, confirm the OmniScript component is visible in the component palette.
  5. For guest users, additionally confirm the guest user profile has access to the OmniScript record via sharing and that no IP or DataRaptor action requires authentication it cannot provide.

Why not the alternative: Assigning only OmniStudio User to the community profile produces access-denied errors at runtime because the community consumer custom permission is absent.


Decision Guidance

SituationRecommended ApproachReason
New org, no prior Vlocity installEnable Standard Runtime, set namespace to omnistudioAvoids managed package dependency
Org has Vlocity managed package, not yet migratingSet Runtime Namespace to correct Vlocity namespace, do not enable Standard Runtime yetPreserves managed package compatibility
Org is mid-migration from Vlocity to nativeEnable Standard Runtime, keep Managed Package Runtime enabled until all components are migratedPer-component migration; mixed state is transitional only
Internal builders need design accessAssign OmniStudioPSL PSL + OmniStudio Admin permission setPSL must precede permission set assignment
Internal consumers onlyAssign OmniStudioPSL PSL + OmniStudio User permission setLeast privilege
Community or portal usersStandard setup + custom community consumer permission setCommunity permission is separate from internal user permission

Recommended Workflow

Step-by-step instructions for an AI agent or practitioner activating this skill:

  1. Gather context — confirm org edition, installed OmniStudio license type, current Runtime Namespace field value, and whether any components have already been opened in Standard designer.
  2. Determine runtime mode — decide between Standard OmniStudio Runtime (native) and Managed Package Runtime based on org state; if the org has no Vlocity packages, use native.
  3. Configure OmniStudio Settings — navigate to Setup > OmniStudio Settings, enable Standard OmniStudio Runtime if applicable, and set the Runtime Namespace to the correct value (omnistudio or the matching Vlocity namespace).
  4. Provision Permission Set Licenses — assign the OmniStudioPSL PSL to every user who will be an admin or consumer before assigning any permission sets.
  5. Assign permission sets — assign OmniStudio Admin to builders and OmniStudio User to consumers; for Experience Cloud users, create and assign the additional community consumer permission set.
  6. Verify activation — open the OmniStudio app, create a test OmniScript, activate it, and confirm it renders; check that consumer users can view the component without errors.
  7. Document the configuration — record the runtime mode, namespace value, and permission set assignments in the deployment runbook for future sandboxes and scratch org refreshes.

Review Checklist

Run through these before marking work in this area complete:

  • OmniStudio Settings page confirms the correct runtime mode (Standard or Managed Package).
  • Runtime Namespace field is populated with the correct namespace value — not blank.
  • All target users have the OmniStudioPSL Permission Set License assigned.
  • Builders have OmniStudio Admin; consumers have OmniStudio User.
  • Experience Cloud community users have the community consumer custom permission.
  • Enhanced Runtime Performance state is deliberate and documented. If it is on, every consumer persona has been access-reviewed and has the Omni Interaction Access Configuration object, and the toggle was trialled in a production-like sandbox first.
  • A test OmniScript activates without errors and renders correctly for both admin and consumer user profiles.
  • Configuration is documented in the deployment runbook so sandbox refreshes replicate it.

Salesforce-Specific Gotchas

Non-obvious platform behaviors that cause real production problems:

  1. Standard Runtime enable is irreversible per component — once a component is opened in the Standard OmniStudio designer, it cannot be converted back to Managed Package Runtime. Plan the cutover carefully before enabling Standard Runtime in production.
  2. Blank Runtime Namespace causes silent activation failures — the OmniStudio Settings page does not validate the namespace field on save; an empty value only surfaces as a cryptic activation error when a user first tries to activate a component.
  3. PSL must precede permission set assignment — attempting to assign OmniStudio Admin or OmniStudio User before assigning the underlying PSL will fail, sometimes silently, in bulk user provisioning scripts.
  4. Community consumer permission is separate from standard user permission — assigning OmniStudio User to a community profile is necessary but not sufficient; the community-consumer custom permission is an additional requirement that is easy to overlook.
  5. Enhanced Runtime Performance re-scopes every component to user mode at once — the toggle reads as tuning, but it makes all components execute in user mode org-wide, so narrow-profile consumers, Experience Cloud users, and guest users break first. Salesforce directs orgs not to enable it directly in production.

Output Artifacts

ArtifactDescription
OmniStudio Settings configuration checklistVerified runtime mode, namespace value, and feature toggle state for the org
Permission set assignment planMaps user populations to PSL and permission set assignments including community users
Post-activation verification logTest activation results for a sample OmniScript confirming correct runtime behavior

Related Skills

  • omnistudio/omnistudio-security — use when reviewing the security posture of OmniStudio permission assignments and data exposure, beyond basic setup.
  • omnistudio/vlocity-to-native-omnistudio-migration — use when the org needs to move from a Vlocity managed package namespace to the native omnistudio runtime.

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Use this skill when writing test-first, behavior-driven acceptance criteria in Given/When/Then format for a Salesforce user story. Covers happy path, edge cases, negative paths, permission boundaries, and data-state preconditions so the AC block can drive UAT scripts and Apex test design downstream. Trigger keywords: given when then, gherkin, behavior driven AC, test first acceptance criteria, scenario outline, BDD acceptance criteria. NOT for the user-story format itself (use admin/user-story-writing-for-salesforce). NOT for UAT script writing (use admin/uat-test-case-design). NOT for Apex test method generation (use agents/test-class-generator). NOT for high-level UAT planning (use admin/uat-and-acceptance-criteria). More triggers: acceptance criteria record, ac_id, req_id on a criterion, artefact under test, negative case for a rule-type requirement, no-match fall-through criterion, oracle for a Then clause, test type apex flow manual, criteria linter, check_ac_format.py, --manifest-dir.

日本語の概要は準備中です。原文の説明を表示しています。

PranavNagrecha/AwesomeSalesforceSkills192026年10月4日 更新

Task and Event objects: polymorphic WhatId/WhoId, Activity object model, ActivityHistory vs OpenActivity, activity timeline customization, bulk task creation, Einstein Activity Capture boundaries. NOT for turning on EAC or calendar sync — use admin/einstein-activity-capture-setup. NOT for Email-to-Case — use admin/case-management-setup. Covers ActivitiesSettings metadata, enableActivities, shared Task/Event custom fields and FLS, TaskStatus value sets, Shared Activities and TaskRelation/EventRelation, recurring and child activities, and partial-success bulk DML on Task.

日本語の概要は準備中です。原文の説明を表示しています。

PranavNagrecha/AwesomeSalesforceSkills192026年10月4日 更新

Design Invocable Apex actions that return deterministic, agent-friendly errors instead of surfacing raw exceptions to the LLM. NOT for authoring the action itself — @InvocableMethod schema, labels, security context — use agentforce/custom-agent-actions-apex. NOT for the Apex tests that force each error branch — use agentforce/agent-action-unit-tests.

日本語の概要は準備中です。原文の説明を表示しています。

PranavNagrecha/AwesomeSalesforceSkills192026年10月4日 更新

Use when designing how an Agentforce agent extracts structured input parameters (slots) from a user's natural-language utterance to invoke an action. Triggers: 'agent extract date from user', 'agent action argument extraction', 'agentforce slot filling', 'agent invocable input mapping', 'agent fails to fill required parameter'. NOT for action authoring (use agentforce/agent-actions) or for prompt-template variable binding (use agentforce/prompt-builder-templates).

日本語の概要は準備中です。原文の説明を表示しています。

PranavNagrecha/AwesomeSalesforceSkills192026年10月4日 更新

Apex test patterns for @InvocableMethod agent actions: per-reason-code branch coverage, bulk safety, callout mocking, deterministic assertions. NOT for testing whether the agent routes to the right topic or answers well — use agentforce/agent-testing-and-evaluation. NOT for designing the error envelope the tests assert on — use agentforce/agent-action-error-handling.

日本語の概要は準備中です。原文の説明を表示しています。

PranavNagrecha/AwesomeSalesforceSkills192026年10月4日 更新

Designing or reviewing Agentforce actions: Flow actions, Apex invocable actions, prompt-template actions, action naming, input and output contracts, confirmation requirements, and safe error behavior. Triggers: 'agent actions', 'build an agent that can look up an order', 'make the agent able to check order status', 'give the agent a capability', 'agent that can retrieve a record', 'flow action for agent', 'agent invocable action', 'action schema design'. NOT for writing the Apex class itself — use agentforce/custom-agent-actions-apex. NOT for the reason_code error envelope that stops an agent retry loop — use agentforce/agent-action-error-handling.

日本語の概要は準備中です。原文の説明を表示しています。

PranavNagrecha/AwesomeSalesforceSkills192026年10月4日 更新

PranavNagrecha のスキルをすべて見る

このスキルの問題を報告する