Data360 Code Extension Generate

作者 forcedotcome5164d94d751无许可证1K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库昨天更新

Develop and deploy Data Cloud Code Extensions using SF CLI plugin. Use this skill when creating custom Python transformations for Data Cloud, deploying code extensions, or testing data transformations. Supports init, run, scan, and deploy operations.

AI 生成的概览

指导通过 SF CLI 插件开发、本地测试、扫描并部署 Salesforce Data Cloud Python 代码扩展。

功能
该技能覆盖 Data Cloud 代码扩展的完整流程:初始化基于脚本或函数的项目、编辑 Python 入口文件、扫描以生成 config.json 和 requirements.txt、校验 DLO 架构、针对组织在本地运行转换,以及部署 payload。它会生成包含 payload/entrypoint.py 和 config.json 的项目脚手架,并提供部署命令与故障排查指引。内容还涉及 CPU 规格选择以及部署后在 Data Cloud 界面中的执行方式。
适用场景
适用于为 Data Cloud 创建自定义 Python 转换、在本地测试、扫描所需权限,或将代码扩展部署到 Salesforce 组织。也适合以编程方式读写 DLO 和 DMO 的工作。
运行要求
需要安装带 @salesforce/plugin-data-code-extension 插件的 SF CLI、Python 3.11、salesforce-data-customcode Python SDK、用于部署的 Docker,以及已认证的 Salesforce 组织。该技能不附带脚本,仅为说明文档,但会引用相关技能中的 get_dlo_schema.py 辅助脚本。

data360-code-extension-generate Skill

Overview

This skill provides a complete workflow for developing, testing, and deploying custom Python code extensions to Salesforce Data Cloud. Code extensions allow you to write Python transformations that read from and write to Data Lake Objects (DLOs) and Data Model Objects (DMOs).

When to Use

  • User wants to create a new code extension project
  • User needs to test a code extension locally
  • User wants to scan code for required permissions
  • User needs to deploy a code extension to Data Cloud
  • User is working with Data Cloud transformations
  • User wants to read/write DLO or DMO data programmatically

Prerequisites Check

Before executing any code extension commands, verify prerequisites:

  1. SF CLI with plugin installed

    bash
    sf plugins --core | grep data-code-extension

    If not installed:

    bash
    sf plugins install @salesforce/plugin-data-code-extension
  2. Python 3.11

    bash
    python --version  # Should show 3.11.x
  3. Data Cloud Custom Code SDK

    bash
    pip list | grep salesforce-data-customcode

    If not installed:

    bash
    pip install salesforce-data-customcode
  4. Docker running (for deploy only)

    bash
    docker ps
  5. Authenticated org

    bash
    sf org display --target-org <org_alias> --json

Skill Workflow

Phase 1: Initialize Project

Create a new code extension project with scaffolding.

Commands:

For script-based code extensions (batch transformations):

bash
sf data-code-extension script init --package-dir <directory>

For function-based code extensions (real-time):

bash
sf data-code-extension function init --package-dir <directory>

Required Option:

  • --package-dir, -p - Directory path where the package will be created

What it creates:

text
my-transform/              # Project root├── payload/               # CRITICAL: This is what --package-dir must point to for deploy│   ├── entrypoint.py      # Main transformation code│   └── config.json        # Code extension configuration├── requirements.txt       # Python dependencies└── README.md

Directory Context During Workflow

IMPORTANT: Understanding the directory structure is critical for successful deployment.

Commands and their directory requirements:

CommandRun FromPath/File Argument
initParent directory<project-name> or .
scanProject root./payload/entrypoint.py
runProject root./payload/entrypoint.py
deployProject root--package-dir ./payload (REQUIRED)

CRITICAL: The --package-dir argument in deploy command MUST point to the payload directory, not the project root.

Phase 2: Develop Transformation

Edit payload/entrypoint.py with transformation logic.

Script Example (Batch):

python
from datacustomcode import Client
client = Client()
# Read from DLOdf = client.read_dlo('Employee__dll')
# Transform data (uppercase position field)df['position_upper'] = df['position'].str.upper()
# Write to output DLOclient.write_to_dlo('Employee_Upper__dll', df, 'overwrite')

Function Example (Real-time):

python
from datacustomcode import FunctionClient
def transform(event, context):    client = FunctionClient(context)    input_data = event['data']    output = {        'name': input_data['name'].upper(),        'status': 'processed'    }    return output

Common Operations:

  • client.read_dlo('DLO_Name__dll') - Read from DLO
  • client.read_dmo('DMO_Name') - Read from DMO
  • client.write_to_dlo('DLO_Name__dll', df, 'overwrite') - Write to DLO
  • client.write_to_dmo('DMO_Name', df, 'upsert') - Write to DMO

Phase 3: Scan for Permissions

Scan the entrypoint file to detect required permissions and generate config.json.

Command:

bash
sf data-code-extension script scan --entrypoint ./payload/entrypoint.py

What it detects:

  • Read permissions for DLOs/DMOs
  • Write permissions for DLOs/DMOs
  • Python package dependencies
  • Updates config.json and requirements.txt

Phase 4: Validate DLO Schema (Pre-Test Check)

CRITICAL: Before running tests locally, validate that all DLOs used in your code exist and have the expected fields.

Step 4a: Extract DLOs from config.json

After scanning, review the generated config.json to identify all DLOs:

bash
cat payload/config.json
Step 4b: Validate Each DLO Schema

Use the data360-schema-get skill to verify DLOs exist and check field names.

For each DLO referenced in your code:

  1. Verify DLO exists:

    bash
    python3 scripts/get_dlo_schema.py <org_alias> <dlo_name>
  2. Verify field names match — compare fields used in your entrypoint.py against the DLO schema.

  3. Check all DLOs:

    • Validate all DLOs in read permissions
    • Validate all DLOs in write permissions
    • Check field names match exactly (case-sensitive)
    • Verify data types are compatible with operations
Step 4c: Validation Checklist

Before proceeding to run, ensure:

  • All DLOs in config.json exist in target org
  • All field names used in code exist in DLO schemas
  • Field data types match your transformation logic
  • Primary key fields are correctly identified
  • Write target DLOs are created and accessible

Phase 5: Test Locally

After validating DLO schemas, run the code extension locally against your Data Cloud org.

Command:

bash
sf data-code-extension script run --entrypoint <entrypoint_file> --target-org <org_alias> [options]

Options:

  • --target-org, -o - SF CLI org alias (required)
  • --config-file, -c - Custom config file path

If you get errors:

  • Re-validate DLO schemas
  • Check field names are exact matches
  • Verify data types are compatible
  • Review error messages for field/DLO issues

Phase 6: Deploy to Data Cloud

Deploy the code extension to Data Cloud for scheduled or on-demand execution.

CRITICAL: You MUST specify --package-dir ./payload to point to the payload directory created by init.

Command:

bash
sf data-code-extension script deploy --target-org <org_alias> --name <name> --package-dir ./payload --package-version <version> --description <description> [options]

Required Options:

  • --target-org, -o - SF CLI org alias
  • --name, -n - Name for code extension deployment
  • --package-dir - Path to payload directory (REQUIRED - must be ./payload when running from project root)
  • --package-version - Version string (default: 0.0.1)
  • --description - Description of code extension

Optional Options:

  • --cpu-size - CPU size: CPU_L, CPU_XL, CPU_2XL (default), CPU_4XL
  • --function-invoke-opt - Function invoke options (for function type)
  • --network - Docker network (default: default)

After deployment:

  • Navigate to Data Cloud in Salesforce UI
  • Go to Data Transforms section
  • Find your deployment by name
  • Click "Run Now" to execute
  • Schedule for recurring execution

Error Handling

Common Issues and Solutions

ErrorSolution
command data-code-extension not foundsf plugins install @salesforce/plugin-data-code-extension
datacustomcode CLI not foundpip install salesforce-data-customcode
Python version mismatchUse pyenv: pyenv install 3.11.0 && pyenv local 3.11.0
Cannot connect to Docker daemonStart Docker Desktop
No org found for aliassf org login web --alias <org_alias>
config.json not foundsf data-code-extension script scan --entrypoint ./payload/entrypoint.py
DLO not foundVerify DLO exists (use data360-schema-get skill), check spelling and __dll suffix
Permission denied writingRe-run scan, verify target DLO exists and is writable
Deploy fails - wrong directoryEnsure --package-dir points to payload/ directory, not project root

Best Practices

Development

  1. Always scan before testing — run scan after code changes
  2. Test locally first — use run command before deploying
  3. Use version control — git commit after each successful test
  4. Version your deployments — use semantic versioning (1.0.0, 1.1.0, etc.)
  5. Deploy from project root with --package-dir ./payload

Performance

  • CPU_L: Small datasets (< 1M records)
  • CPU_2XL: Medium datasets (1M-10M records)
  • CPU_4XL: Large datasets (> 10M records)

Security

  1. No hardcoded credentials — use SF CLI authentication only
  2. Validate input data — check for nulls and data types
  3. Limit write permissions — only grant necessary DLO/DMO access

Integration with Other Skills

Use with data360-schema-get skill (CRITICAL for validation):

The data360-schema-get skill is required for validating DLOs before testing code extensions.

Use with Datakit Workflow:

  1. Create DLO via code extension
  2. Map DLO to DMO using datakit workflow
  3. Use DMO in segments and activations

Command Reference

CommandPurposeRequired Args
script initCreate new script project--package-dir
function initCreate new function project--package-dir
script scanGenerate configentrypoint file
script runTest locallyentrypoint file, --target-org
script deployDeploy to Data Cloud--target-org, --name, --package-dir, --package-version, --description

Resources

Notes

  • Code extensions run in isolated Python 3.11 environment
  • Docker is required only for deployment, not for local testing
  • Use SF CLI authentication only (no separate credential files)
  • Scan command auto-detects permissions from code
  • Local run uses actual Data Cloud data (not mocked)
  • Deployments are versioned and can be rolled back in UI

来源与署名

来源:forcedotcom/sf-skills位于skills/data360-code-extension-generate提交e5164d9

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架

更多来自 forcedotcom/sf-skills 的技能

Service Itsm Teams Itservice Configure

forcedotcom

Configure the "Set Up Salesforce IT Service" checklist for Microsoft Teams Employee Service (ITSM) — the employee side, covering app enablement, marketplace install guidance, user access assignment, and Digital Experience Site selection. Use this for: 'turn on Salesforce IT Service', 'set up IT Service on Teams', 'assign Teams for Employee permission set', 'give employees access to Teams for Employee Service', 'manage user access for Teams ITSM', 'grant users the permission sets needed for Teams Employee Service', 'select a digital experience site for Teams', 'install Salesforce IT Service app on Teams', or any request to complete the IT Service half of the Teams ITSM Go page checklist (including the Manage User Access step). DO NOT TRIGGER for the base Teams Salesforce Go page toggle or Azure/Entra app setup (service-itsm-teams-configure) or for the IT Desk/fulfiller half of the checklist (service-itsm-teams-itdesk-configure).

待分类1K昨天更新

Service Itsm Teams Coordinate

forcedotcom

End-to-end autopilot orchestrator for setting up Microsoft Teams integration in Salesforce Service Cloud ITSM — runs the whole flow (enable the Teams for Employee Service Go feature, register the Microsoft Entra app, populate Named Credentials, configure the IT Desk and IT Service checklists, turn on Swarming, and optionally embed the Agentforce agent) in one continuous pass, stopping only at the points a human must act. Use when the user asks to set up Microsoft Teams for ITSM end to end, 'set up teams for it service', 'do the whole teams itsm setup', 'configure microsoft teams for employee service', or wants a guided Teams ITSM walkthrough. Delegates each stage to a specialized child skill while driving the sequence itself. DO NOT TRIGGER when the user asks to enable Teams alone, configure just the IT Desk or IT Service checklist alone, or enable Swarming alone — delegate directly to the specific child skill in those cases.

待分类1K昨天更新

Service Itsm Teams Itdesk Configure

forcedotcom

Configure the "Set Up Salesforce IT Desk" checklist for Microsoft Teams Employee Service (ITSM) — the fulfiller/agent side, covering app enablement, marketplace install guidance, user access assignment, and Swarming collaboration-tool setup. Use this for: 'turn on Salesforce IT Desk', 'set up IT Desk on Teams', 'assign Teams for IT Desk permission set', 'set Teams as collaboration tool for swarming', 'install Salesforce IT Desk app on Teams', or any request to complete the IT Desk half of the Teams ITSM Go page checklist. DO NOT TRIGGER for the base Teams Salesforce Go page toggle or Azure/Entra app setup (service-itsm-teams-configure) or for the IT Service/employee half of the checklist (service-itsm-teams-itservice-configure).

待分类1K昨天更新

Service Itsm Teams Debug

forcedotcom

通过针对 Salesforce 组织运行通过/失败配置检查清单,诊断 Microsoft Teams 员工服务(ITSM)配置故障。

DevOps & Cloud1K昨天更新

Service Itsm Teams Employee Agent Configure

forcedotcom

Configure the embedded Agentforce Employee Agent so it replies inside the Microsoft Teams ITSM custom client ('Salesforce Employee Assist' / 'Ask AI Agent'). Use this for: 'set up employee agent in Teams', 'embed Agentforce agent in Teams', 'make the IT Service Employee Agent reply in Teams', 'Teams Ask AI Agent not responding', 'agent joins then leaves without replying', 'configure MIAW deployment for Teams employee agent', 'Teams embedded messaging agent setup'. Builds the whole stack headlessly (zero Setup-UI clicks): the Web messaging channel with User Verification ON, the Enhanced Chat User Verification Key Set (JWKS_URL) it requires, the Teams_AgentForce custom-client deployment, the routing flow to the agent, and the Agent Access permission set that lets the portal user reach the agent. DO NOT TRIGGER for enabling the Teams feature Salesforce Go page toggle (service-itsm-teams-configure) or for configuring notification preferences.

待分类1K昨天更新

Service Itsm Swarming Configure

forcedotcom

通过 Connect API 调用启用 Salesforce Swarming ITSM 功能,并将协作工具设为 Teams。

DevOps & Cloud1K昨天更新